AU eRequesting Implementation Guide
1.0.1-ci-build - CI Build Australia flag

AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions

Resource Profile: AUeRequestingDiagnosticRequestBundle - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the au-erequesting-bundle-diagnosticrequest resource profile.

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

0. Bundle
Definition

A container for a collection of resources.

ShortContains a collection of resources
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsbdl-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-3: entry.request mandatory for batch/transaction/history, otherwise prohibited (entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited (entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')))
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) ((type = 'history') or entry.where(fullUrl.exists()).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-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
au-ereq-bundle-01: The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count())
au-ereq-bundle-02: Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl))
au-ereq-bundle-03: Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl))
au-ereq-bundle-04: Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. (entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')))
au-ereq-bundle-06: The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. (entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct())
au-ereq-bundle-07: Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. (entry.all(request.method = 'POST' or request.method = 'PUT'))
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-3: entry.request mandatory for batch/transaction/history, otherwise prohibited (entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited (entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')))
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) ((type = 'history') or entry.where(fullUrl.exists()).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-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Bundle.type
Definition

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

Shortdocument | 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|4.0.1
(required to http://hl7.org/fhir/ValueSet/bundle-type|4.0.1)

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

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
    ObligationsActor
    SHALL:populateAU eRequesting Placer
    SHALL:handleAU eRequesting Server
    SHALL:able-to-populateAU eRequesting Server
    Summarytrue
    Fixed Valuetransaction
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    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
    Control70..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Obligations
      ObligationsActor
      SHALL:populateAU eRequesting Placer
      SHALL:handleAU eRequesting Server
      SHALL:able-to-populateAU eRequesting Server
      Summarytrue
      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      SlicingThis element introduces a set of slices on Bundle.entry. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • type @ resource
      • profile @ 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 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 manageable, 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).

        ShortExtensions that cannot be ignored even if unrecognized
        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        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.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        10. Bundle.entry:patient
        Slice Namepatient
        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
        Control10..1*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActor
          SHALL:populateAU eRequesting Placer
          SHALL:handleAU eRequesting Server
          SHALL:able-to-populateAU eRequesting Server
          Summarytrue
          Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
          12. Bundle.entry:patient.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 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 manageable, 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).

          ShortExtensions that cannot be ignored even if unrecognized
          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          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.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          14. Bundle.entry:patient.fullUrl
          Definition

          The Absolute URL for the resource. 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. 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.
          ShortURI for resource (Absolute URL server address or URI for UUID/OID)
          Comments

          fullUrl might 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 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, 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).


          fullUrl might 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 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, 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).

          Control10..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Obligations
            ObligationsActor
            SHALL:populateAU eRequesting Placer
            SHALL:handleAU eRequesting Server
            SHALL:able-to-populateAU eRequesting Server
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            16. Bundle.entry:patient.resource
            Definition

            Demographics and other administrative information about an individual receiving care or other health-related services.


            The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

            ShortA patient in the context of electronic exchange of health informationA resource in the bundle
            Control10..1
            TypePatientResource(AU eRequesting Patient)
            Is Modifierfalse
            Summaryfalse
            Alternate NamesSubjectOfCare Client Resident
            18. Bundle.entry:patient.request
            Definition

            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.

            ShortAdditional execution information (transaction/batch/history)
            Control10..1
            This element is affected by the following invariants: bdl-3
            TypeBackboneElement
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. Bundle.entry:patient.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 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 manageable, 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).

            ShortExtensions that cannot be ignored even if unrecognized
            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            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.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            22. Bundle.entry:patient.request.method
            Definition

            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.

            ShortPOST | PUT (create or conditional update only)GET | HEAD | POST | PUT | DELETE | PATCH
            Comments

            In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

            HTTP verbs (in the HTTP command line). See HTTP rfc for details.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Obligations
              ObligationsActor
              SHALL:populateAU eRequesting Placer
              SHALL:handleAU eRequesting Server
              SHALL:able-to-populateAU eRequesting Server
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              24. Bundle.entry:patient.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
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Obligations
                ObligationsActor
                SHALL:populateAU eRequesting Placer
                SHALL:handleAU eRequesting Server
                SHALL:able-to-populateAU eRequesting Server
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. Bundle.entry:patient.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
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Obligations
                  ObligationsActor
                  SHALL:populate-if-knownAU eRequesting Placer
                  SHALL:handleAU eRequesting Server
                  SHALL:able-to-populateAU eRequesting Server
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  28. Bundle.entry:requestingPractitioner
                  Slice NamerequestingPractitioner
                  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
                  Control10..1*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Obligations
                    ObligationsActor
                    SHALL:populateAU eRequesting Placer
                    SHALL:handleAU eRequesting Server
                    SHALL:able-to-populateAU eRequesting Server
                    Summarytrue
                    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                    bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                    bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                    30. Bundle.entry:requestingPractitioner.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 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 manageable, 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).

                    ShortExtensions that cannot be ignored even if unrecognized
                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

                    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.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    32. Bundle.entry:requestingPractitioner.fullUrl
                    Definition

                    The Absolute URL for the resource. 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. 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.
                    ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                    Comments

                    fullUrl might 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 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, 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).


                    fullUrl might 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 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, 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).

                    Control10..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Obligations
                      ObligationsActor
                      SHALL:populateAU eRequesting Placer
                      SHALL:handleAU eRequesting Server
                      SHALL:able-to-populateAU eRequesting Server
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      34. Bundle.entry:requestingPractitioner.resource
                      Definition

                      A person who is directly or indirectly involved in the provisioning of healthcare.


                      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                      ShortA person with a formal responsibility in the provisioning of servicesA resource in the bundle
                      Control10..1
                      TypePractitionerResource(AU eRequesting Practitioner)
                      Is Modifierfalse
                      Summaryfalse
                      36. Bundle.entry:requestingPractitioner.request
                      Definition

                      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.

                      ShortAdditional execution information (transaction/batch/history)
                      Control10..1
                      This element is affected by the following invariants: bdl-3
                      TypeBackboneElement
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. Bundle.entry:requestingPractitioner.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 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 manageable, 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).

                      ShortExtensions that cannot be ignored even if unrecognized
                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      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.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      40. Bundle.entry:requestingPractitioner.request.method
                      Definition

                      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.

                      ShortPOST | PUT (create or conditional update only)GET | HEAD | POST | PUT | DELETE | PATCH
                      Comments

                      In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                      HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Obligations
                        ObligationsActor
                        SHALL:populateAU eRequesting Placer
                        SHALL:handleAU eRequesting Server
                        SHALL:able-to-populateAU eRequesting Server
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        42. Bundle.entry:requestingPractitioner.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
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:populateAU eRequesting Placer
                          SHALL:handleAU eRequesting Server
                          SHALL:able-to-populateAU eRequesting Server
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          44. Bundle.entry:requestingPractitioner.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
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            SHALL:populate-if-knownAU eRequesting Placer
                            SHALL:handleAU eRequesting Server
                            SHALL:able-to-populateAU eRequesting Server
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            46. Bundle.entry:requestingPractitionerRole
                            Slice NamerequestingPractitionerRole
                            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
                            Control10..1*
                            TypeBackboneElement
                            Is Modifierfalse
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              SHALL:populateAU eRequesting Placer
                              SHALL:handleAU eRequesting Server
                              SHALL:able-to-populateAU eRequesting Server
                              Summarytrue
                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                              48. Bundle.entry:requestingPractitionerRole.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 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 manageable, 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).

                              ShortExtensions that cannot be ignored even if unrecognized
                              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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                              Summarytrue
                              Requirements

                              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.

                              Alternate Namesextensions, user content, modifiers
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              50. Bundle.entry:requestingPractitionerRole.fullUrl
                              Definition

                              The Absolute URL for the resource. 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. 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.
                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                              Comments

                              fullUrl might 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 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, 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).


                              fullUrl might 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 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, 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).

                              Control10..1
                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Obligations
                                ObligationsActor
                                SHALL:populateAU eRequesting Placer
                                SHALL:handleAU eRequesting Server
                                SHALL:able-to-populateAU eRequesting Server
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                52. Bundle.entry:requestingPractitionerRole.resource
                                Definition

                                A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.


                                The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                ShortA person with formal responsibility in a role providing one or more servicesA resource in the bundle
                                Control10..1
                                TypePractitionerRoleResource(AU eRequesting PractitionerRole)
                                Is Modifierfalse
                                Summaryfalse
                                54. Bundle.entry:requestingPractitionerRole.request
                                Definition

                                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.

                                ShortAdditional execution information (transaction/batch/history)
                                Control10..1
                                This element is affected by the following invariants: bdl-3
                                TypeBackboneElement
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                56. Bundle.entry:requestingPractitionerRole.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 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 manageable, 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).

                                ShortExtensions that cannot be ignored even if unrecognized
                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                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.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                58. Bundle.entry:requestingPractitionerRole.request.method
                                Definition

                                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.

                                ShortPOST | PUT (create or conditional update only)GET | HEAD | POST | PUT | DELETE | PATCH
                                Comments

                                In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Obligations
                                  ObligationsActor
                                  SHALL:populateAU eRequesting Placer
                                  SHALL:handleAU eRequesting Server
                                  SHALL:able-to-populateAU eRequesting Server
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  60. Bundle.entry:requestingPractitionerRole.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
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActor
                                    SHALL:populateAU eRequesting Placer
                                    SHALL:handleAU eRequesting Server
                                    SHALL:able-to-populateAU eRequesting Server
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    62. Bundle.entry:requestingPractitionerRole.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
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Obligations
                                      ObligationsActor
                                      SHALL:populate-if-knownAU eRequesting Placer
                                      SHALL:handleAU eRequesting Server
                                      SHALL:able-to-populateAU eRequesting Server
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      64. Bundle.entry:organization
                                      Slice Nameorganization
                                      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
                                      Control10..2*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        SHALL:populateAU eRequesting Placer
                                        SHALL:handleAU eRequesting Server
                                        SHALL:able-to-populateAU eRequesting Server
                                        Summarytrue
                                        Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                        bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                        bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                        66. Bundle.entry:organization.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 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 manageable, 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).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        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.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        68. Bundle.entry:organization.fullUrl
                                        Definition

                                        The Absolute URL for the resource. 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. 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.
                                        ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                        Comments

                                        fullUrl might 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 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, 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).


                                        fullUrl might 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 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, 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).

                                        Control10..1
                                        Typeuri
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        Obligations
                                          ObligationsActor
                                          SHALL:populateAU eRequesting Placer
                                          SHALL:handleAU eRequesting Server
                                          SHALL:able-to-populateAU eRequesting Server
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          70. Bundle.entry:organization.resource
                                          Definition

                                          A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.


                                          The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                          ShortAn organisation in an Australian healthcare contextA resource in the bundle
                                          Control10..1
                                          TypeOrganizationResource(AU eRequesting Organization)
                                          Is Modifierfalse
                                          Summaryfalse
                                          72. Bundle.entry:organization.request
                                          Definition

                                          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.

                                          ShortAdditional execution information (transaction/batch/history)
                                          Control10..1
                                          This element is affected by the following invariants: bdl-3
                                          TypeBackboneElement
                                          Is Modifierfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          74. Bundle.entry:organization.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 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 manageable, 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).

                                          ShortExtensions that cannot be ignored even if unrecognized
                                          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                          Summarytrue
                                          Requirements

                                          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.

                                          Alternate Namesextensions, user content, modifiers
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          76. Bundle.entry:organization.request.method
                                          Definition

                                          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.

                                          ShortPOST | PUT (create or conditional update only)GET | HEAD | POST | PUT | DELETE | PATCH
                                          Comments

                                          In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                          HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Obligations
                                            ObligationsActor
                                            SHALL:populateAU eRequesting Placer
                                            SHALL:handleAU eRequesting Server
                                            SHALL:able-to-populateAU eRequesting Server
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            78. Bundle.entry:organization.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
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActor
                                              SHALL:populateAU eRequesting Placer
                                              SHALL:handleAU eRequesting Server
                                              SHALL:able-to-populateAU eRequesting Server
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              80. Bundle.entry:organization.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
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supporttrue
                                              Obligations
                                                ObligationsActor
                                                SHALL:populate-if-knownAU eRequesting Placer
                                                SHALL:handleAU eRequesting Server
                                                SHALL:able-to-populateAU eRequesting Server
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                82. Bundle.entry:serviceRequest
                                                Slice NameserviceRequest
                                                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
                                                Control10..*
                                                TypeBackboneElement
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:populateAU eRequesting Placer
                                                  SHALL:handleAU eRequesting Server
                                                  SHALL:able-to-populateAU eRequesting Server
                                                  Summarytrue
                                                  Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                  84. Bundle.entry:serviceRequest.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 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 manageable, 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).

                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                  Summarytrue
                                                  Requirements

                                                  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.

                                                  Alternate Namesextensions, user content, modifiers
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  86. Bundle.entry:serviceRequest.fullUrl
                                                  Definition

                                                  The Absolute URL for the resource. 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. 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.
                                                  ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                  Comments

                                                  fullUrl might 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 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, 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).


                                                  fullUrl might 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 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, 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).

                                                  Control10..1
                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Obligations
                                                    ObligationsActor
                                                    SHALL:populateAU eRequesting Placer
                                                    SHALL:handleAU eRequesting Server
                                                    SHALL:able-to-populateAU eRequesting Server
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    88. Bundle.entry:serviceRequest.resource
                                                    Definition

                                                    A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.


                                                    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                    ShortA service request in an Australian healthcare contextA resource in the bundle
                                                    Control10..1
                                                    TypeServiceRequestResource(AU eRequesting Diagnostic Request)
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesdiagnostic request, referral, referral request, transfer of care request
                                                    90. Bundle.entry:serviceRequest.request
                                                    Definition

                                                    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.

                                                    ShortAdditional execution information (transaction/batch/history)
                                                    Control10..1
                                                    This element is affected by the following invariants: bdl-3
                                                    TypeBackboneElement
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    92. Bundle.entry:serviceRequest.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 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 manageable, 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).

                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                    Summarytrue
                                                    Requirements

                                                    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.

                                                    Alternate Namesextensions, user content, modifiers
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    94. Bundle.entry:serviceRequest.request.method
                                                    Definition

                                                    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.

                                                    ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                    Comments

                                                    In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                    HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                    Typecode
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Obligations
                                                      ObligationsActor
                                                      SHALL:populateAU eRequesting Placer
                                                      SHALL:handleAU eRequesting Server
                                                      SHALL:able-to-populateAU eRequesting Server
                                                      Summarytrue
                                                      Fixed ValuePOST
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      96. Bundle.entry:serviceRequest.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
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Obligations
                                                        ObligationsActor
                                                        SHALL:populateAU eRequesting Placer
                                                        SHALL:handleAU eRequesting Server
                                                        SHALL:able-to-populateAU eRequesting Server
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        98. Bundle.entry:taskGroup
                                                        Slice NametaskGroup
                                                        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
                                                        Control10..1*
                                                        TypeBackboneElement
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Obligations
                                                          ObligationsActor
                                                          SHALL:populateAU eRequesting Placer
                                                          SHALL:handleAU eRequesting Server
                                                          SHALL:able-to-populateAU eRequesting Server
                                                          Summarytrue
                                                          Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                          100. Bundle.entry:taskGroup.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 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 manageable, 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).

                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                          Summarytrue
                                                          Requirements

                                                          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.

                                                          Alternate Namesextensions, user content, modifiers
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          102. Bundle.entry:taskGroup.fullUrl
                                                          Definition

                                                          The Absolute URL for the resource. 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. 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.
                                                          ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                          Comments

                                                          fullUrl might 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 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, 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).


                                                          fullUrl might 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 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, 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).

                                                          Control10..1
                                                          Typeuri
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Obligations
                                                            ObligationsActor
                                                            SHALL:populateAU eRequesting Placer
                                                            SHALL:handleAU eRequesting Server
                                                            SHALL:able-to-populateAU eRequesting Server
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            104. Bundle.entry:taskGroup.resource
                                                            Definition

                                                            A task to be performed.


                                                            The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                            ShortA task to be performedA resource in the bundle
                                                            Control10..1
                                                            TypeTaskResource(AU eRequesting Task Group)
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            106. Bundle.entry:taskGroup.request
                                                            Definition

                                                            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.

                                                            ShortAdditional execution information (transaction/batch/history)
                                                            Control10..1
                                                            This element is affected by the following invariants: bdl-3
                                                            TypeBackboneElement
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            108. Bundle.entry:taskGroup.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 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 manageable, 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).

                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                            Summarytrue
                                                            Requirements

                                                            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.

                                                            Alternate Namesextensions, user content, modifiers
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            110. Bundle.entry:taskGroup.request.method
                                                            Definition

                                                            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.

                                                            ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                            Comments

                                                            In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                            HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Obligations
                                                              ObligationsActor
                                                              SHALL:populateAU eRequesting Placer
                                                              SHALL:handleAU eRequesting Server
                                                              SHALL:able-to-populateAU eRequesting Server
                                                              Summarytrue
                                                              Fixed ValuePOST
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              112. Bundle.entry:taskGroup.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
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Obligations
                                                                ObligationsActor
                                                                SHALL:populateAU eRequesting Placer
                                                                SHALL:handleAU eRequesting Server
                                                                SHALL:able-to-populateAU eRequesting Server
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                114. Bundle.entry:taskDiagnosticRequest
                                                                Slice NametaskDiagnosticRequest
                                                                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
                                                                Control10..*
                                                                TypeBackboneElement
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Obligations
                                                                  ObligationsActor
                                                                  SHALL:populateAU eRequesting Placer
                                                                  SHALL:handleAU eRequesting Server
                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                  Summarytrue
                                                                  Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                  116. Bundle.entry:taskDiagnosticRequest.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 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 manageable, 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).

                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                  Summarytrue
                                                                  Requirements

                                                                  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.

                                                                  Alternate Namesextensions, user content, modifiers
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  118. Bundle.entry:taskDiagnosticRequest.fullUrl
                                                                  Definition

                                                                  The Absolute URL for the resource. 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. 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.
                                                                  ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                  Comments

                                                                  fullUrl might 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 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, 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).


                                                                  fullUrl might 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 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, 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).

                                                                  Control10..1
                                                                  Typeuri
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supporttrue
                                                                  Obligations
                                                                    ObligationsActor
                                                                    SHALL:populateAU eRequesting Placer
                                                                    SHALL:handleAU eRequesting Server
                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    120. Bundle.entry:taskDiagnosticRequest.resource
                                                                    Definition

                                                                    A task to be performed.


                                                                    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                    ShortA task to be performedA resource in the bundle
                                                                    Control10..1
                                                                    TypeTaskResource(AU eRequesting Task Diagnostic Request)
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    122. Bundle.entry:taskDiagnosticRequest.request
                                                                    Definition

                                                                    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.

                                                                    ShortAdditional execution information (transaction/batch/history)
                                                                    Control10..1
                                                                    This element is affected by the following invariants: bdl-3
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    124. Bundle.entry:taskDiagnosticRequest.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 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 manageable, 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).

                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                    Summarytrue
                                                                    Requirements

                                                                    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.

                                                                    Alternate Namesextensions, user content, modifiers
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    126. Bundle.entry:taskDiagnosticRequest.request.method
                                                                    Definition

                                                                    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.

                                                                    ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                                    Comments

                                                                    In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                    HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                    Typecode
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Must Supporttrue
                                                                    Obligations
                                                                      ObligationsActor
                                                                      SHALL:populateAU eRequesting Placer
                                                                      SHALL:handleAU eRequesting Server
                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                      Summarytrue
                                                                      Fixed ValuePOST
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      128. Bundle.entry:taskDiagnosticRequest.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
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supporttrue
                                                                      Obligations
                                                                        ObligationsActor
                                                                        SHALL:populateAU eRequesting Placer
                                                                        SHALL:handleAU eRequesting Server
                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        130. Bundle.entry:encounter
                                                                        Slice Nameencounter
                                                                        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..1*
                                                                        TypeBackboneElement
                                                                        Is Modifierfalse
                                                                        Must Supporttrue
                                                                        Obligations
                                                                          ObligationsActor
                                                                          SHALL:populate-if-knownAU eRequesting Placer
                                                                          SHALL:handleAU eRequesting Server
                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                          Summarytrue
                                                                          Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                          132. Bundle.entry:encounter.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 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 manageable, 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).

                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                          Summarytrue
                                                                          Requirements

                                                                          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.

                                                                          Alternate Namesextensions, user content, modifiers
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          134. Bundle.entry:encounter.fullUrl
                                                                          Definition

                                                                          The Absolute URL for the resource. 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. 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.
                                                                          ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                          Comments

                                                                          fullUrl might 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 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, 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).


                                                                          fullUrl might 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 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, 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).

                                                                          Control10..1
                                                                          Typeuri
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supporttrue
                                                                          Obligations
                                                                            ObligationsActor
                                                                            SHALL:populateAU eRequesting Placer
                                                                            SHALL:handleAU eRequesting Server
                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            136. Bundle.entry:encounter.resource
                                                                            Definition

                                                                            An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.


                                                                            The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                            ShortAn encounter in an Australian healthcare contextA resource in the bundle
                                                                            Control10..1
                                                                            TypeEncounterResource(AU eRequesting Encounter)
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Alternate NamesVisit
                                                                            138. Bundle.entry:encounter.request
                                                                            Definition

                                                                            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.

                                                                            ShortAdditional execution information (transaction/batch/history)
                                                                            Control10..1
                                                                            This element is affected by the following invariants: bdl-3
                                                                            TypeBackboneElement
                                                                            Is Modifierfalse
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            140. Bundle.entry:encounter.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 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 manageable, 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).

                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                            Summarytrue
                                                                            Requirements

                                                                            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.

                                                                            Alternate Namesextensions, user content, modifiers
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            142. Bundle.entry:encounter.request.method
                                                                            Definition

                                                                            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.

                                                                            ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                                            Comments

                                                                            In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                            HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                            Typecode
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Must Supporttrue
                                                                            Obligations
                                                                              ObligationsActor
                                                                              SHALL:populateAU eRequesting Placer
                                                                              SHALL:handleAU eRequesting Server
                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                              Summarytrue
                                                                              Fixed ValuePOST
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              144. Bundle.entry:encounter.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
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Must Supporttrue
                                                                              Obligations
                                                                                ObligationsActor
                                                                                SHALL:populateAU eRequesting Placer
                                                                                SHALL:handleAU eRequesting Server
                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                146. Bundle.entry:coverage
                                                                                Slice Namecoverage
                                                                                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
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Obligations
                                                                                  ObligationsActor
                                                                                  SHALL:populate-if-knownAU eRequesting Placer
                                                                                  SHALL:handleAU eRequesting Server
                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                  Summarytrue
                                                                                  Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                  148. Bundle.entry:coverage.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 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 manageable, 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).

                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  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.

                                                                                  Alternate Namesextensions, user content, modifiers
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  150. Bundle.entry:coverage.fullUrl
                                                                                  Definition

                                                                                  The Absolute URL for the resource. 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. 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.
                                                                                  ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                  Comments

                                                                                  fullUrl might 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 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, 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).


                                                                                  fullUrl might 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 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, 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).

                                                                                  Control10..1
                                                                                  Typeuri
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Must Supporttrue
                                                                                  Obligations
                                                                                    ObligationsActor
                                                                                    SHALL:populateAU eRequesting Placer
                                                                                    SHALL:handleAU eRequesting Server
                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    152. Bundle.entry:coverage.resource
                                                                                    Definition

                                                                                    Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.


                                                                                    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                    ShortInsurance or medical plan or a payment agreementA resource in the bundle
                                                                                    Comments

                                                                                    The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

                                                                                    Control10..1
                                                                                    TypeCoverageResource(AU eRequesting Coverage)
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    154. Bundle.entry:coverage.request
                                                                                    Definition

                                                                                    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.

                                                                                    ShortAdditional execution information (transaction/batch/history)
                                                                                    Control10..1
                                                                                    This element is affected by the following invariants: bdl-3
                                                                                    TypeBackboneElement
                                                                                    Is Modifierfalse
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    156. Bundle.entry:coverage.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 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 manageable, 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).

                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    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.

                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    158. Bundle.entry:coverage.request.method
                                                                                    Definition

                                                                                    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.

                                                                                    ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                                                    Comments

                                                                                    In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                    HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                    Typecode
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Must Supporttrue
                                                                                    Obligations
                                                                                      ObligationsActor
                                                                                      SHALL:populateAU eRequesting Placer
                                                                                      SHALL:handleAU eRequesting Server
                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                      Summarytrue
                                                                                      Fixed ValuePOST
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      160. Bundle.entry:coverage.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
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supporttrue
                                                                                      Obligations
                                                                                        ObligationsActor
                                                                                        SHALL:populateAU eRequesting Placer
                                                                                        SHALL:handleAU eRequesting Server
                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        162. Bundle.entry:clinicalContextDocument
                                                                                        Slice NameclinicalContextDocument
                                                                                        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
                                                                                        Is Modifierfalse
                                                                                        Must Supporttrue
                                                                                        Obligations
                                                                                          ObligationsActor
                                                                                          SHALL:populate-if-knownAU eRequesting Placer
                                                                                          SHALL:handleAU eRequesting Server
                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                          Summarytrue
                                                                                          Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                          164. Bundle.entry:clinicalContextDocument.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 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 manageable, 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).

                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          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.

                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          166. Bundle.entry:clinicalContextDocument.fullUrl
                                                                                          Definition

                                                                                          The Absolute URL for the resource. 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. 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.
                                                                                          ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                          Comments

                                                                                          fullUrl might 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 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, 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).


                                                                                          fullUrl might 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 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, 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).

                                                                                          Control10..1
                                                                                          Typeuri
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Must Supporttrue
                                                                                          Obligations
                                                                                            ObligationsActor
                                                                                            SHALL:populateAU eRequesting Placer
                                                                                            SHALL:handleAU eRequesting Server
                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                            Summarytrue
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            168. Bundle.entry:clinicalContextDocument.resource
                                                                                            Definition

                                                                                            A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.


                                                                                            The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                            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(AU eRequesting Clinical Context DocumentReference)
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            170. Bundle.entry:clinicalContextDocument.request
                                                                                            Definition

                                                                                            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.

                                                                                            ShortAdditional execution information (transaction/batch/history)
                                                                                            Control10..1
                                                                                            This element is affected by the following invariants: bdl-3
                                                                                            TypeBackboneElement
                                                                                            Is Modifierfalse
                                                                                            Summarytrue
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            172. Bundle.entry:clinicalContextDocument.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 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 manageable, 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).

                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                            Summarytrue
                                                                                            Requirements

                                                                                            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.

                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            174. Bundle.entry:clinicalContextDocument.request.method
                                                                                            Definition

                                                                                            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.

                                                                                            ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                                                            Comments

                                                                                            In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                            HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                            Typecode
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Must Supporttrue
                                                                                            Obligations
                                                                                              ObligationsActor
                                                                                              SHALL:populateAU eRequesting Placer
                                                                                              SHALL:handleAU eRequesting Server
                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                              Summarytrue
                                                                                              Fixed ValuePOST
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              176. Bundle.entry:clinicalContextDocument.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
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supporttrue
                                                                                              Obligations
                                                                                                ObligationsActor
                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                SHALL:handleAU eRequesting Server
                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                Summarytrue
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                178. Bundle.entry:communicationRequest
                                                                                                Slice NamecommunicationRequest
                                                                                                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
                                                                                                Is Modifierfalse
                                                                                                Must Supporttrue
                                                                                                Obligations
                                                                                                  ObligationsActor
                                                                                                  SHALL:populate-if-knownAU eRequesting Placer
                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                  Summarytrue
                                                                                                  Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                  180. Bundle.entry:communicationRequest.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 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 manageable, 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).

                                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                  Summarytrue
                                                                                                  Requirements

                                                                                                  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.

                                                                                                  Alternate Namesextensions, user content, modifiers
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                  182. Bundle.entry:communicationRequest.fullUrl
                                                                                                  Definition

                                                                                                  The Absolute URL for the resource. 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. 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.
                                                                                                  ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                  Comments

                                                                                                  fullUrl might 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 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, 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).


                                                                                                  fullUrl might 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 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, 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).

                                                                                                  Control10..1
                                                                                                  Typeuri
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supporttrue
                                                                                                  Obligations
                                                                                                    ObligationsActor
                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                    Summarytrue
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    184. Bundle.entry:communicationRequest.resource
                                                                                                    Definition

                                                                                                    A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.


                                                                                                    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                                    ShortA request for information to be sent to a receiverA resource in the bundle
                                                                                                    Control10..1
                                                                                                    TypeCommunicationRequestResource(AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Urgent Provider, AU eRequesting CommunicationRequest Patient)
                                                                                                    Is Modifierfalse
                                                                                                    Summaryfalse
                                                                                                    186. Bundle.entry:communicationRequest.request
                                                                                                    Definition

                                                                                                    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.

                                                                                                    ShortAdditional execution information (transaction/batch/history)
                                                                                                    Control10..1
                                                                                                    This element is affected by the following invariants: bdl-3
                                                                                                    TypeBackboneElement
                                                                                                    Is Modifierfalse
                                                                                                    Summarytrue
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    188. Bundle.entry:communicationRequest.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 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 manageable, 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).

                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    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.

                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                    190. Bundle.entry:communicationRequest.request.method
                                                                                                    Definition

                                                                                                    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.

                                                                                                    ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                                                                    Comments

                                                                                                    In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                    HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                    Typecode
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Must Supporttrue
                                                                                                    Obligations
                                                                                                      ObligationsActor
                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                      Summarytrue
                                                                                                      Fixed ValuePOST
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      192. Bundle.entry:communicationRequest.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
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supporttrue
                                                                                                      Obligations
                                                                                                        ObligationsActor
                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                        Summarytrue
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        194. Bundle.entry:supportingObservation
                                                                                                        Slice NamesupportingObservation
                                                                                                        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
                                                                                                        Is Modifierfalse
                                                                                                        Must Supporttrue
                                                                                                        Obligations
                                                                                                          ObligationsActor
                                                                                                          SHALL:populate-if-knownAU eRequesting Placer
                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                          Summarytrue
                                                                                                          Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                          196. Bundle.entry:supportingObservation.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 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 manageable, 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).

                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          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.

                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          198. Bundle.entry:supportingObservation.fullUrl
                                                                                                          Definition

                                                                                                          The Absolute URL for the resource. 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. 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.
                                                                                                          ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                          Comments

                                                                                                          fullUrl might 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 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, 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).


                                                                                                          fullUrl might 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 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, 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).

                                                                                                          Control10..1
                                                                                                          Typeuri
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Obligations
                                                                                                            ObligationsActor
                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                            Summarytrue
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            200. Bundle.entry:supportingObservation.resource
                                                                                                            Definition

                                                                                                            The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                                            ShortA resource in the bundle
                                                                                                            Control10..1
                                                                                                            TypeObservationResource
                                                                                                            Is Modifierfalse
                                                                                                            Summarytrue
                                                                                                            202. Bundle.entry:supportingObservation.request
                                                                                                            Definition

                                                                                                            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.

                                                                                                            ShortAdditional execution information (transaction/batch/history)
                                                                                                            Control10..1
                                                                                                            This element is affected by the following invariants: bdl-3
                                                                                                            TypeBackboneElement
                                                                                                            Is Modifierfalse
                                                                                                            Summarytrue
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            204. Bundle.entry:supportingObservation.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 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 manageable, 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).

                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                            Summarytrue
                                                                                                            Requirements

                                                                                                            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.

                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                            206. Bundle.entry:supportingObservation.request.method
                                                                                                            Definition

                                                                                                            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.

                                                                                                            ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                                                                            Comments

                                                                                                            In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                            HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                            Typecode
                                                                                                            Is Modifierfalse
                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                            Must Supporttrue
                                                                                                            Obligations
                                                                                                              ObligationsActor
                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                              Summarytrue
                                                                                                              Fixed ValuePOST
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              208. Bundle.entry:supportingObservation.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
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Obligations
                                                                                                                ObligationsActor
                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                Summarytrue
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                210. Bundle.entry:location
                                                                                                                Slice Namelocation
                                                                                                                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
                                                                                                                Is Modifierfalse
                                                                                                                Must Supporttrue
                                                                                                                Obligations
                                                                                                                  ObligationsActor
                                                                                                                  SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                  Summarytrue
                                                                                                                  Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                  212. Bundle.entry:location.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 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 manageable, 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).

                                                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                  Summarytrue
                                                                                                                  Requirements

                                                                                                                  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.

                                                                                                                  Alternate Namesextensions, user content, modifiers
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                  214. Bundle.entry:location.fullUrl
                                                                                                                  Definition

                                                                                                                  The Absolute URL for the resource. 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. 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.
                                                                                                                  ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                  Comments

                                                                                                                  fullUrl might 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 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, 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).


                                                                                                                  fullUrl might 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 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, 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).

                                                                                                                  Control10..1
                                                                                                                  Typeuri
                                                                                                                  Is Modifierfalse
                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                  Must Supporttrue
                                                                                                                  Obligations
                                                                                                                    ObligationsActor
                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                    Summarytrue
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    216. Bundle.entry:location.resource
                                                                                                                    Definition

                                                                                                                    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                                                    ShortA resource in the bundle
                                                                                                                    Control10..1
                                                                                                                    TypeLocationResource
                                                                                                                    Is Modifierfalse
                                                                                                                    Summarytrue
                                                                                                                    218. Bundle.entry:location.request
                                                                                                                    Definition

                                                                                                                    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.

                                                                                                                    ShortAdditional execution information (transaction/batch/history)
                                                                                                                    Control10..1
                                                                                                                    This element is affected by the following invariants: bdl-3
                                                                                                                    TypeBackboneElement
                                                                                                                    Is Modifierfalse
                                                                                                                    Summarytrue
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    220. Bundle.entry:location.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 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 manageable, 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).

                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    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.

                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                    222. Bundle.entry:location.request.method
                                                                                                                    Definition

                                                                                                                    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.

                                                                                                                    ShortPOST (create only)GET | HEAD | POST | PUT | DELETE | PATCH
                                                                                                                    Comments

                                                                                                                    In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                    HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                    Typecode
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supporttrue
                                                                                                                    Obligations
                                                                                                                      ObligationsActor
                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                      Summarytrue
                                                                                                                      Fixed ValuePOST
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      224. Bundle.entry:location.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
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supporttrue
                                                                                                                      Obligations
                                                                                                                        ObligationsActor
                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                        Summarytrue
                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                                                                                                                        0. Bundle
                                                                                                                        Invariantsau-ereq-bundle-01: The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count())
                                                                                                                        au-ereq-bundle-02: Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl))
                                                                                                                        au-ereq-bundle-03: Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl))
                                                                                                                        au-ereq-bundle-04: Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. (entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')))
                                                                                                                        au-ereq-bundle-06: The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. (entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct())
                                                                                                                        au-ereq-bundle-07: Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. (entry.all(request.method = 'POST' or request.method = 'PUT'))
                                                                                                                        2. Bundle.type
                                                                                                                        Must Supporttrue
                                                                                                                        Obligations
                                                                                                                          ObligationsActor
                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                          Fixed Valuetransaction
                                                                                                                          4. Bundle.entry
                                                                                                                          Control7..?
                                                                                                                          Must Supporttrue
                                                                                                                          Obligations
                                                                                                                            ObligationsActor
                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                            SlicingThis element introduces a set of slices on Bundle.entry. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                            • type @ resource
                                                                                                                            • profile @ resource
                                                                                                                            • 6. Bundle.entry.request
                                                                                                                              8. Bundle.entry.request.method
                                                                                                                              ShortPOST | PUT (create or conditional update only)
                                                                                                                              Comments

                                                                                                                              In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

                                                                                                                              10. Bundle.entry:patient
                                                                                                                              Slice Namepatient
                                                                                                                              Control1..1
                                                                                                                              Must Supporttrue
                                                                                                                              Obligations
                                                                                                                                ObligationsActor
                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                12. Bundle.entry:patient.fullUrl
                                                                                                                                Control1..?
                                                                                                                                Must Supporttrue
                                                                                                                                Obligations
                                                                                                                                  ObligationsActor
                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                  14. Bundle.entry:patient.resource
                                                                                                                                  Control1..?
                                                                                                                                  TypePatient(AU eRequesting Patient)
                                                                                                                                  16. Bundle.entry:patient.request
                                                                                                                                  Control1..?
                                                                                                                                  18. Bundle.entry:patient.request.method
                                                                                                                                  Must Supporttrue
                                                                                                                                  Obligations
                                                                                                                                    ObligationsActor
                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                    20. Bundle.entry:patient.request.url
                                                                                                                                    Must Supporttrue
                                                                                                                                    Obligations
                                                                                                                                      ObligationsActor
                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                      22. Bundle.entry:patient.request.ifNoneExist
                                                                                                                                      Must Supporttrue
                                                                                                                                      Obligations
                                                                                                                                        ObligationsActor
                                                                                                                                        SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                        24. Bundle.entry:requestingPractitioner
                                                                                                                                        Slice NamerequestingPractitioner
                                                                                                                                        Control1..1
                                                                                                                                        Must Supporttrue
                                                                                                                                        Obligations
                                                                                                                                          ObligationsActor
                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                          26. Bundle.entry:requestingPractitioner.fullUrl
                                                                                                                                          Control1..?
                                                                                                                                          Must Supporttrue
                                                                                                                                          Obligations
                                                                                                                                            ObligationsActor
                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                            28. Bundle.entry:requestingPractitioner.resource
                                                                                                                                            Control1..?
                                                                                                                                            TypePractitioner(AU eRequesting Practitioner)
                                                                                                                                            30. Bundle.entry:requestingPractitioner.request
                                                                                                                                            Control1..?
                                                                                                                                            32. Bundle.entry:requestingPractitioner.request.method
                                                                                                                                            Must Supporttrue
                                                                                                                                            Obligations
                                                                                                                                              ObligationsActor
                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                              34. Bundle.entry:requestingPractitioner.request.url
                                                                                                                                              Must Supporttrue
                                                                                                                                              Obligations
                                                                                                                                                ObligationsActor
                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                36. Bundle.entry:requestingPractitioner.request.ifNoneExist
                                                                                                                                                Must Supporttrue
                                                                                                                                                Obligations
                                                                                                                                                  ObligationsActor
                                                                                                                                                  SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                  38. Bundle.entry:requestingPractitionerRole
                                                                                                                                                  Slice NamerequestingPractitionerRole
                                                                                                                                                  Control1..1
                                                                                                                                                  Must Supporttrue
                                                                                                                                                  Obligations
                                                                                                                                                    ObligationsActor
                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                    40. Bundle.entry:requestingPractitionerRole.fullUrl
                                                                                                                                                    Control1..?
                                                                                                                                                    Must Supporttrue
                                                                                                                                                    Obligations
                                                                                                                                                      ObligationsActor
                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                      42. Bundle.entry:requestingPractitionerRole.resource
                                                                                                                                                      Control1..?
                                                                                                                                                      TypePractitionerRole(AU eRequesting PractitionerRole)
                                                                                                                                                      44. Bundle.entry:requestingPractitionerRole.request
                                                                                                                                                      Control1..?
                                                                                                                                                      46. Bundle.entry:requestingPractitionerRole.request.method
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      Obligations
                                                                                                                                                        ObligationsActor
                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                        48. Bundle.entry:requestingPractitionerRole.request.url
                                                                                                                                                        Must Supporttrue
                                                                                                                                                        Obligations
                                                                                                                                                          ObligationsActor
                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                          50. Bundle.entry:requestingPractitionerRole.request.ifNoneExist
                                                                                                                                                          Must Supporttrue
                                                                                                                                                          Obligations
                                                                                                                                                            ObligationsActor
                                                                                                                                                            SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                            52. Bundle.entry:organization
                                                                                                                                                            Slice Nameorganization
                                                                                                                                                            Control1..2
                                                                                                                                                            Must Supporttrue
                                                                                                                                                            Obligations
                                                                                                                                                              ObligationsActor
                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                              54. Bundle.entry:organization.fullUrl
                                                                                                                                                              Control1..?
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Obligations
                                                                                                                                                                ObligationsActor
                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                56. Bundle.entry:organization.resource
                                                                                                                                                                Control1..?
                                                                                                                                                                TypeOrganization(AU eRequesting Organization)
                                                                                                                                                                58. Bundle.entry:organization.request
                                                                                                                                                                Control1..?
                                                                                                                                                                60. Bundle.entry:organization.request.method
                                                                                                                                                                Must Supporttrue
                                                                                                                                                                Obligations
                                                                                                                                                                  ObligationsActor
                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                  62. Bundle.entry:organization.request.url
                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                  Obligations
                                                                                                                                                                    ObligationsActor
                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                    64. Bundle.entry:organization.request.ifNoneExist
                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                    Obligations
                                                                                                                                                                      ObligationsActor
                                                                                                                                                                      SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                      66. Bundle.entry:serviceRequest
                                                                                                                                                                      Slice NameserviceRequest
                                                                                                                                                                      Control1..*
                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                      Obligations
                                                                                                                                                                        ObligationsActor
                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                        68. Bundle.entry:serviceRequest.fullUrl
                                                                                                                                                                        Control1..?
                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                        Obligations
                                                                                                                                                                          ObligationsActor
                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                          70. Bundle.entry:serviceRequest.resource
                                                                                                                                                                          Control1..?
                                                                                                                                                                          TypeServiceRequest(AU eRequesting Diagnostic Request)
                                                                                                                                                                          72. Bundle.entry:serviceRequest.request
                                                                                                                                                                          Control1..?
                                                                                                                                                                          74. Bundle.entry:serviceRequest.request.method
                                                                                                                                                                          ShortPOST (create only)
                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                          Obligations
                                                                                                                                                                            ObligationsActor
                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                            Fixed ValuePOST
                                                                                                                                                                            76. Bundle.entry:serviceRequest.request.url
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Obligations
                                                                                                                                                                              ObligationsActor
                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                              78. Bundle.entry:taskGroup
                                                                                                                                                                              Slice NametaskGroup
                                                                                                                                                                              Control1..1
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Obligations
                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                80. Bundle.entry:taskGroup.fullUrl
                                                                                                                                                                                Control1..?
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Obligations
                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                  82. Bundle.entry:taskGroup.resource
                                                                                                                                                                                  Control1..?
                                                                                                                                                                                  TypeTask(AU eRequesting Task Group)
                                                                                                                                                                                  84. Bundle.entry:taskGroup.request
                                                                                                                                                                                  Control1..?
                                                                                                                                                                                  86. Bundle.entry:taskGroup.request.method
                                                                                                                                                                                  ShortPOST (create only)
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Obligations
                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                    Fixed ValuePOST
                                                                                                                                                                                    88. Bundle.entry:taskGroup.request.url
                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                    Obligations
                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                      90. Bundle.entry:taskDiagnosticRequest
                                                                                                                                                                                      Slice NametaskDiagnosticRequest
                                                                                                                                                                                      Control1..*
                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                      Obligations
                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                        92. Bundle.entry:taskDiagnosticRequest.fullUrl
                                                                                                                                                                                        Control1..?
                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                        Obligations
                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                          94. Bundle.entry:taskDiagnosticRequest.resource
                                                                                                                                                                                          Control1..?
                                                                                                                                                                                          TypeTask(AU eRequesting Task Diagnostic Request)
                                                                                                                                                                                          96. Bundle.entry:taskDiagnosticRequest.request
                                                                                                                                                                                          Control1..?
                                                                                                                                                                                          98. Bundle.entry:taskDiagnosticRequest.request.method
                                                                                                                                                                                          ShortPOST (create only)
                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                          Obligations
                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                            Fixed ValuePOST
                                                                                                                                                                                            100. Bundle.entry:taskDiagnosticRequest.request.url
                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                            Obligations
                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                              102. Bundle.entry:encounter
                                                                                                                                                                                              Slice Nameencounter
                                                                                                                                                                                              Control0..1
                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                              Obligations
                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                104. Bundle.entry:encounter.fullUrl
                                                                                                                                                                                                Control1..?
                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                Obligations
                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                  106. Bundle.entry:encounter.resource
                                                                                                                                                                                                  Control1..?
                                                                                                                                                                                                  TypeEncounter(AU eRequesting Encounter)
                                                                                                                                                                                                  108. Bundle.entry:encounter.request
                                                                                                                                                                                                  Control1..?
                                                                                                                                                                                                  110. Bundle.entry:encounter.request.method
                                                                                                                                                                                                  ShortPOST (create only)
                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                    Fixed ValuePOST
                                                                                                                                                                                                    112. Bundle.entry:encounter.request.url
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                      114. Bundle.entry:coverage
                                                                                                                                                                                                      Slice Namecoverage
                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                        SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                        116. Bundle.entry:coverage.fullUrl
                                                                                                                                                                                                        Control1..?
                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                          118. Bundle.entry:coverage.resource
                                                                                                                                                                                                          Control1..?
                                                                                                                                                                                                          TypeCoverage(AU eRequesting Coverage)
                                                                                                                                                                                                          120. Bundle.entry:coverage.request
                                                                                                                                                                                                          Control1..?
                                                                                                                                                                                                          122. Bundle.entry:coverage.request.method
                                                                                                                                                                                                          ShortPOST (create only)
                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                            Fixed ValuePOST
                                                                                                                                                                                                            124. Bundle.entry:coverage.request.url
                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                              126. Bundle.entry:clinicalContextDocument
                                                                                                                                                                                                              Slice NameclinicalContextDocument
                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                128. Bundle.entry:clinicalContextDocument.fullUrl
                                                                                                                                                                                                                Control1..?
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                  130. Bundle.entry:clinicalContextDocument.resource
                                                                                                                                                                                                                  Control1..?
                                                                                                                                                                                                                  TypeDocumentReference(AU eRequesting Clinical Context DocumentReference)
                                                                                                                                                                                                                  132. Bundle.entry:clinicalContextDocument.request
                                                                                                                                                                                                                  Control1..?
                                                                                                                                                                                                                  134. Bundle.entry:clinicalContextDocument.request.method
                                                                                                                                                                                                                  ShortPOST (create only)
                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                    Fixed ValuePOST
                                                                                                                                                                                                                    136. Bundle.entry:clinicalContextDocument.request.url
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                      138. Bundle.entry:communicationRequest
                                                                                                                                                                                                                      Slice NamecommunicationRequest
                                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                        SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                        140. Bundle.entry:communicationRequest.fullUrl
                                                                                                                                                                                                                        Control1..?
                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                          142. Bundle.entry:communicationRequest.resource
                                                                                                                                                                                                                          Control1..?
                                                                                                                                                                                                                          TypeCommunicationRequest(AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Urgent Provider, AU eRequesting CommunicationRequest Patient)
                                                                                                                                                                                                                          144. Bundle.entry:communicationRequest.request
                                                                                                                                                                                                                          Control1..?
                                                                                                                                                                                                                          146. Bundle.entry:communicationRequest.request.method
                                                                                                                                                                                                                          ShortPOST (create only)
                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                            Fixed ValuePOST
                                                                                                                                                                                                                            148. Bundle.entry:communicationRequest.request.url
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                              150. Bundle.entry:supportingObservation
                                                                                                                                                                                                                              Slice NamesupportingObservation
                                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                152. Bundle.entry:supportingObservation.fullUrl
                                                                                                                                                                                                                                Control1..?
                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                  154. Bundle.entry:supportingObservation.resource
                                                                                                                                                                                                                                  Control1..?
                                                                                                                                                                                                                                  TypeObservation
                                                                                                                                                                                                                                  156. Bundle.entry:supportingObservation.request
                                                                                                                                                                                                                                  Control1..?
                                                                                                                                                                                                                                  158. Bundle.entry:supportingObservation.request.method
                                                                                                                                                                                                                                  ShortPOST (create only)
                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                    Fixed ValuePOST
                                                                                                                                                                                                                                    160. Bundle.entry:supportingObservation.request.url
                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                      162. Bundle.entry:location
                                                                                                                                                                                                                                      Slice Namelocation
                                                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                        SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                        164. Bundle.entry:location.fullUrl
                                                                                                                                                                                                                                        Control1..?
                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                          166. Bundle.entry:location.resource
                                                                                                                                                                                                                                          Control1..?
                                                                                                                                                                                                                                          TypeLocation
                                                                                                                                                                                                                                          168. Bundle.entry:location.request
                                                                                                                                                                                                                                          Control1..?
                                                                                                                                                                                                                                          170. Bundle.entry:location.request.method
                                                                                                                                                                                                                                          ShortPOST (create only)
                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                            Fixed ValuePOST
                                                                                                                                                                                                                                            172. Bundle.entry:location.request.url
                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server

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

                                                                                                                                                                                                                                              0. Bundle
                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                              A container for a collection of resources.

                                                                                                                                                                                                                                              ShortContains a collection of resources
                                                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                              Invariantsbdl-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-3: entry.request mandatory for batch/transaction/history, otherwise prohibited (entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')))
                                                                                                                                                                                                                                              bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited (entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')))
                                                                                                                                                                                                                                              bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) ((type = 'history') or entry.where(fullUrl.exists()).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-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
                                                                                                                                                                                                                                              bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
                                                                                                                                                                                                                                              bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
                                                                                                                                                                                                                                              au-ereq-bundle-01: The number of Task Diagnostic Request entries shall equal the number of ServiceRequest entries. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).count() = entry.where(resource is ServiceRequest).count())
                                                                                                                                                                                                                                              au-ereq-bundle-02: Every Task Diagnostic Request focus reference shall resolve to a ServiceRequest entry within the bundle. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.focus.reference in %resource.entry.fullUrl))
                                                                                                                                                                                                                                              au-ereq-bundle-03: Every Task Diagnostic Request partOf reference shall resolve to the Task Group entry within the bundle. (entry.where(resource is Task and resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-diagnosticrequest').exists()).all(resource.partOf.reference in %resource.entry.where(resource.meta.profile.where($this = 'http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group').exists()).fullUrl))
                                                                                                                                                                                                                                              au-ereq-bundle-04: Every entry.fullUrl shall be a urn:uuid: value with a lowercase UUID. (entry.all(fullUrl.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')))
                                                                                                                                                                                                                                              au-ereq-bundle-06: The placer identifier value shall be unique across all ServiceRequest entries in the bundle. The placer identifier (ServiceRequest.identifier slice 'placer', type PLAC) is the per-test handle used by the $transfer operation; duplicate values would make a partial transfer ambiguous. (entry.where(resource is ServiceRequest).select(resource.identifier.where(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PLAC').exists()).value).isDistinct())
                                                                                                                                                                                                                                              au-ereq-bundle-07: Every entry request method shall be POST or PUT. The bundle creates resources (POST, optionally with ifNoneExist) or conditionally updates them by identifier (PUT); read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted in a diagnostic request submission. (entry.all(request.method = 'POST' or request.method = 'PUT'))
                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                              4. Bundle.meta
                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                              ShortMetadata about the resource
                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                              TypeMeta
                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                              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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                                                                                                                                                                                                                              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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                                              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                              BindingThe codes SHOULD be taken from CommonLanguages
                                                                                                                                                                                                                                              (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                                                                                                                                                                                                                              A human language.

                                                                                                                                                                                                                                              Additional BindingsPurpose
                                                                                                                                                                                                                                              AllLanguagesMax Binding
                                                                                                                                                                                                                                              Typecode
                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                              10. Bundle.identifier
                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                              A persistent identifier for the bundle that won't change as a bundle 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
                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                              12. Bundle.type
                                                                                                                                                                                                                                              Definition

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

                                                                                                                                                                                                                                              Shortdocument | 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 BundleType
                                                                                                                                                                                                                                              (required to http://hl7.org/fhir/ValueSet/bundle-type|4.0.1)

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

                                                                                                                                                                                                                                              Typecode
                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                Fixed Valuetransaction
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                14. Bundle.timestamp
                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

                                                                                                                                                                                                                                                ShortWhen the bundle was assembled
                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                Typeinstant
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                16. Bundle.total
                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                If a set of search matches, this is the 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.

                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                18. Bundle.link
                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                A series of links that provide context to this bundle.

                                                                                                                                                                                                                                                ShortLinks related to this Bundle
                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

                                                                                                                                                                                                                                                Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

                                                                                                                                                                                                                                                This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

                                                                                                                                                                                                                                                Control0..*
                                                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                20. 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.

                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                22. Bundle.link.extension
                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                24. 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 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 manageable, 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).

                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                26. 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
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                28. Bundle.link.url
                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                The reference details for the link.

                                                                                                                                                                                                                                                ShortReference details for the link
                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                Typeuri
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                30. 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
                                                                                                                                                                                                                                                Control7..*
                                                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                  Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                  bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                  SlicingThis element introduces a set of slices on Bundle.entry. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                                                  • type @ resource
                                                                                                                                                                                                                                                  • profile @ resource
                                                                                                                                                                                                                                                  • 32. 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.

                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    34. Bundle.entry.extension
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    36. 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 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 manageable, 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).

                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    38. Bundle.entry.link
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    A series of links that provide context to this entry.

                                                                                                                                                                                                                                                    ShortLinks related to this entry
                                                                                                                                                                                                                                                    Control0..*
                                                                                                                                                                                                                                                    TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    40. Bundle.entry.fullUrl
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                    ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                                    fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    42. Bundle.entry.resource
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                                                                                                                                                                                    ShortA resource in the bundle
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    TypeResource
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    44. 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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    46. 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.

                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    48. Bundle.entry.search.extension
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    50. 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 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 manageable, 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).

                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    52. 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, or to convey information or warning information about the search process.

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

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    Typecode
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    54. 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.

                                                                                                                                                                                                                                                    See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typedecimal
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    56. Bundle.entry.request
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    58. 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.

                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    60. Bundle.entry.request.extension
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    62. 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 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 manageable, 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).

                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    64. Bundle.entry.request.method
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    ShortPOST | PUT (create or conditional update only)
                                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                                    In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                    HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                    Typecode
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    66. 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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    68. 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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    70. Bundle.entry.request.ifModifiedSince
                                                                                                                                                                                                                                                    Definition

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

                                                                                                                                                                                                                                                    ShortFor managing cache currency
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    72. 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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    74. 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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    76. Bundle.entry.response
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    78. 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.

                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    80. Bundle.entry.response.extension
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    82. 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 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 manageable, 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).

                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                    84. 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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    86. Bundle.entry.response.location
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                    ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    88. Bundle.entry.response.etag
                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                    The Etag for the resource, if 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
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    90. 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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                    92. 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.

                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                    TypeResource
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                    94. Bundle.entry:patient
                                                                                                                                                                                                                                                    Slice Namepatient
                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                      96. Bundle.entry:patient.id
                                                                                                                                                                                                                                                      Definition

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

                                                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                      98. Bundle.entry:patient.extension
                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                      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 manageable, 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.

                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                      100. Bundle.entry:patient.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 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 manageable, 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).

                                                                                                                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                      102. Bundle.entry:patient.link
                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                      A series of links that provide context to this entry.

                                                                                                                                                                                                                                                      ShortLinks related to this entry
                                                                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                      104. Bundle.entry:patient.fullUrl
                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                      The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                                                      fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        106. Bundle.entry:patient.resource
                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                        Demographics and other administrative information about an individual receiving care or other health-related services.

                                                                                                                                                                                                                                                        ShortA patient in the context of electronic exchange of health information
                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                        TypePatient(AU eRequesting Patient)
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                        Alternate NamesSubjectOfCare Client Resident
                                                                                                                                                                                                                                                        108. Bundle.entry:patient.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
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        110. Bundle.entry:patient.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.

                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                        112. Bundle.entry:patient.search.extension
                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                        114. Bundle.entry:patient.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 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 manageable, 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).

                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                        116. Bundle.entry:patient.search.mode
                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                        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.

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

                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        118. Bundle.entry:patient.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.

                                                                                                                                                                                                                                                        See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                        Typedecimal
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        120. Bundle.entry:patient.request
                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                        ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                        This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        122. Bundle.entry:patient.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.

                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                        124. Bundle.entry:patient.request.extension
                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                        126. Bundle.entry:patient.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 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 manageable, 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).

                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                        128. Bundle.entry:patient.request.method
                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                        ShortPOST | PUT (create or conditional update only)
                                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                                        In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                        HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                          130. Bundle.entry:patient.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
                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                            132. Bundle.entry:patient.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
                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                            134. Bundle.entry:patient.request.ifModifiedSince
                                                                                                                                                                                                                                                            Definition

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

                                                                                                                                                                                                                                                            ShortFor managing cache currency
                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                            136. Bundle.entry:patient.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
                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                            138. Bundle.entry:patient.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
                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                                              SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              140. Bundle.entry:patient.response
                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                              This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                              TypeBackboneElement
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              142. Bundle.entry:patient.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.

                                                                                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                              144. Bundle.entry:patient.response.extension
                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                              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 manageable, 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.

                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                              146. Bundle.entry:patient.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 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 manageable, 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).

                                                                                                                                                                                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                              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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                              148. Bundle.entry:patient.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
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              150. Bundle.entry:patient.response.location
                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                              The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                              ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              152. Bundle.entry:patient.response.etag
                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                              The Etag for the resource, if 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
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              154. Bundle.entry:patient.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                              Typeinstant
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                              156. Bundle.entry:patient.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.

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                              TypeResource
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                              158. Bundle.entry:requestingPractitioner
                                                                                                                                                                                                                                                              Slice NamerequestingPractitioner
                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                                                              TypeBackboneElement
                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                160. Bundle.entry:requestingPractitioner.id
                                                                                                                                                                                                                                                                Definition

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

                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                162. Bundle.entry:requestingPractitioner.extension
                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                164. Bundle.entry:requestingPractitioner.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 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 manageable, 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).

                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                166. Bundle.entry:requestingPractitioner.link
                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                ShortLinks related to this entry
                                                                                                                                                                                                                                                                Control0..*
                                                                                                                                                                                                                                                                TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                168. Bundle.entry:requestingPractitioner.fullUrl
                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                                fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                Typeuri
                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  170. Bundle.entry:requestingPractitioner.resource
                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                  A person who is directly or indirectly involved in the provisioning of healthcare.

                                                                                                                                                                                                                                                                  ShortA person with a formal responsibility in the provisioning of services
                                                                                                                                                                                                                                                                  Control1..1
                                                                                                                                                                                                                                                                  TypePractitioner(AU eRequesting Practitioner)
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                                                                  172. Bundle.entry:requestingPractitioner.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
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  174. Bundle.entry:requestingPractitioner.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.

                                                                                                                                                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                                                                  176. Bundle.entry:requestingPractitioner.search.extension
                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                  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 manageable, 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.

                                                                                                                                                                                                                                                                  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
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                                                                  Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                  178. Bundle.entry:requestingPractitioner.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 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 manageable, 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).

                                                                                                                                                                                                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                  Requirements

                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                  Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                  180. Bundle.entry:requestingPractitioner.search.mode
                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                  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.

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

                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                  Typecode
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  182. Bundle.entry:requestingPractitioner.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.

                                                                                                                                                                                                                                                                  See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                  Typedecimal
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  184. Bundle.entry:requestingPractitioner.request
                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                  ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                  Control1..1
                                                                                                                                                                                                                                                                  This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                  TypeBackboneElement
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  186. Bundle.entry:requestingPractitioner.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.

                                                                                                                                                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                                                                  188. Bundle.entry:requestingPractitioner.request.extension
                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                  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 manageable, 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.

                                                                                                                                                                                                                                                                  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
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                                                                  Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                  190. Bundle.entry:requestingPractitioner.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 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 manageable, 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).

                                                                                                                                                                                                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                  Requirements

                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                  Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                  192. Bundle.entry:requestingPractitioner.request.method
                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                  ShortPOST | PUT (create or conditional update only)
                                                                                                                                                                                                                                                                  Comments

                                                                                                                                                                                                                                                                  In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                  HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                  Typecode
                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                    194. Bundle.entry:requestingPractitioner.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
                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                      196. Bundle.entry:requestingPractitioner.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
                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                      198. Bundle.entry:requestingPractitioner.request.ifModifiedSince
                                                                                                                                                                                                                                                                      Definition

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

                                                                                                                                                                                                                                                                      ShortFor managing cache currency
                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                      Typeinstant
                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                      200. Bundle.entry:requestingPractitioner.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
                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                      202. Bundle.entry:requestingPractitioner.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
                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                                                        SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        204. Bundle.entry:requestingPractitioner.response
                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                        ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                        This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        206. Bundle.entry:requestingPractitioner.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.

                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                        208. Bundle.entry:requestingPractitioner.response.extension
                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                        210. Bundle.entry:requestingPractitioner.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 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 manageable, 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).

                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                        212. Bundle.entry:requestingPractitioner.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
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        214. Bundle.entry:requestingPractitioner.response.location
                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                        The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                        ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                        Typeuri
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        216. Bundle.entry:requestingPractitioner.response.etag
                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                        The Etag for the resource, if 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
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        218. Bundle.entry:requestingPractitioner.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                        Typeinstant
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                        220. Bundle.entry:requestingPractitioner.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.

                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                        TypeResource
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                        222. Bundle.entry:requestingPractitionerRole
                                                                                                                                                                                                                                                                        Slice NamerequestingPractitionerRole
                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                          Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                          224. Bundle.entry:requestingPractitionerRole.id
                                                                                                                                                                                                                                                                          Definition

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

                                                                                                                                                                                                                                                                          ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                                                                                          226. Bundle.entry:requestingPractitionerRole.extension
                                                                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                                                                          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 manageable, 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.

                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                          Summaryfalse
                                                                                                                                                                                                                                                                          Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                          228. Bundle.entry:requestingPractitionerRole.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 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 manageable, 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).

                                                                                                                                                                                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                          Requirements

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                          230. Bundle.entry:requestingPractitionerRole.link
                                                                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                                                                          A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                          ShortLinks related to this entry
                                                                                                                                                                                                                                                                          Control0..*
                                                                                                                                                                                                                                                                          TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                          232. Bundle.entry:requestingPractitionerRole.fullUrl
                                                                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                                                                          The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                          ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                          Comments

                                                                                                                                                                                                                                                                          fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                          Control1..1
                                                                                                                                                                                                                                                                          Typeuri
                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            234. Bundle.entry:requestingPractitionerRole.resource
                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                            A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

                                                                                                                                                                                                                                                                            ShortA person with formal responsibility in a role providing one or more services
                                                                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                                                                            TypePractitionerRole(AU eRequesting PractitionerRole)
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                            236. Bundle.entry:requestingPractitionerRole.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
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            238. Bundle.entry:requestingPractitionerRole.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.

                                                                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                            240. Bundle.entry:requestingPractitionerRole.search.extension
                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                            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 manageable, 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.

                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                            242. Bundle.entry:requestingPractitionerRole.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 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 manageable, 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).

                                                                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                            244. Bundle.entry:requestingPractitionerRole.search.mode
                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                            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.

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

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            Typecode
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            246. Bundle.entry:requestingPractitionerRole.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.

                                                                                                                                                                                                                                                                            See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                            Typedecimal
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            248. Bundle.entry:requestingPractitionerRole.request
                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                                                                            This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            250. Bundle.entry:requestingPractitionerRole.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.

                                                                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                            252. Bundle.entry:requestingPractitionerRole.request.extension
                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                            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 manageable, 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.

                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                            254. Bundle.entry:requestingPractitionerRole.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 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 manageable, 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).

                                                                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                            256. Bundle.entry:requestingPractitionerRole.request.method
                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            ShortPOST | PUT (create or conditional update only)
                                                                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                                                                            In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                            HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                            Typecode
                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                              258. Bundle.entry:requestingPractitionerRole.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
                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                260. Bundle.entry:requestingPractitionerRole.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
                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                262. Bundle.entry:requestingPractitionerRole.request.ifModifiedSince
                                                                                                                                                                                                                                                                                Definition

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

                                                                                                                                                                                                                                                                                ShortFor managing cache currency
                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                Typeinstant
                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                264. Bundle.entry:requestingPractitionerRole.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
                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                266. Bundle.entry:requestingPractitionerRole.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
                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                                                  SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  268. Bundle.entry:requestingPractitionerRole.response
                                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                  ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                                  This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                  TypeBackboneElement
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  270. Bundle.entry:requestingPractitionerRole.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.

                                                                                                                                                                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                                                                                  272. Bundle.entry:requestingPractitionerRole.response.extension
                                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                                  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 manageable, 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.

                                                                                                                                                                                                                                                                                  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
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                                                                                                                  Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                  274. Bundle.entry:requestingPractitionerRole.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  Requirements

                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                  Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                  276. Bundle.entry:requestingPractitionerRole.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
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  278. Bundle.entry:requestingPractitionerRole.response.location
                                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                                  The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                  ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                                  Typeuri
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  280. Bundle.entry:requestingPractitionerRole.response.etag
                                                                                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                                                                                  The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  282. Bundle.entry:requestingPractitionerRole.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                                  Typeinstant
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                  284. Bundle.entry:requestingPractitionerRole.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.

                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                                                                                  TypeResource
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                  286. Bundle.entry:organization
                                                                                                                                                                                                                                                                                  Slice Nameorganization
                                                                                                                                                                                                                                                                                  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
                                                                                                                                                                                                                                                                                  Control1..2
                                                                                                                                                                                                                                                                                  TypeBackboneElement
                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                    bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                    288. Bundle.entry:organization.id
                                                                                                                                                                                                                                                                                    Definition

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

                                                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                    290. Bundle.entry:organization.extension
                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                    292. Bundle.entry:organization.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                    294. Bundle.entry:organization.link
                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                    A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                    ShortLinks related to this entry
                                                                                                                                                                                                                                                                                    Control0..*
                                                                                                                                                                                                                                                                                    TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                    296. Bundle.entry:organization.fullUrl
                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                    The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                    ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                                                                    fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      298. Bundle.entry:organization.resource
                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                      A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                                                                                                                                                                                                                                                                                      ShortAn organisation in an Australian healthcare context
                                                                                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                                                                                      TypeOrganization(AU eRequesting Organization)
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                      300. Bundle.entry:organization.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
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      302. Bundle.entry:organization.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.

                                                                                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                      304. Bundle.entry:organization.search.extension
                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                      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 manageable, 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.

                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                      306. Bundle.entry:organization.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                      308. Bundle.entry:organization.search.mode
                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                      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.

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

                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                      Typecode
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      310. Bundle.entry:organization.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.

                                                                                                                                                                                                                                                                                      See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                                      Typedecimal
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      312. Bundle.entry:organization.request
                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                      ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                                                                                      This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                      TypeBackboneElement
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      314. Bundle.entry:organization.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.

                                                                                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                      316. Bundle.entry:organization.request.extension
                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                      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 manageable, 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.

                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                      318. Bundle.entry:organization.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                      320. Bundle.entry:organization.request.method
                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                      ShortPOST | PUT (create or conditional update only)
                                                                                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                                                                                      In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                      HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                      Typecode
                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                        322. Bundle.entry:organization.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
                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                          324. Bundle.entry:organization.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
                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                          326. Bundle.entry:organization.request.ifModifiedSince
                                                                                                                                                                                                                                                                                          Definition

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

                                                                                                                                                                                                                                                                                          ShortFor managing cache currency
                                                                                                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                                                                                                          Typeinstant
                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                          328. Bundle.entry:organization.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
                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                          330. Bundle.entry:organization.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
                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                                                                            SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            332. Bundle.entry:organization.response
                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                            ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                            This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            334. Bundle.entry:organization.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.

                                                                                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                            336. Bundle.entry:organization.response.extension
                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                            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 manageable, 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.

                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                            338. Bundle.entry:organization.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                            340. Bundle.entry:organization.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
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            342. Bundle.entry:organization.response.location
                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                            The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                            ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            344. Bundle.entry:organization.response.etag
                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                            The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            346. Bundle.entry:organization.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                            348. Bundle.entry:organization.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.

                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                            TypeResource
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                            350. Bundle.entry:serviceRequest
                                                                                                                                                                                                                                                                                            Slice NameserviceRequest
                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                            Control1..*
                                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                              352. Bundle.entry:serviceRequest.id
                                                                                                                                                                                                                                                                                              Definition

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

                                                                                                                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                              354. Bundle.entry:serviceRequest.extension
                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                              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 manageable, 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.

                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                              356. Bundle.entry:serviceRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                              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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                              358. Bundle.entry:serviceRequest.link
                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                              A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                              ShortLinks related to this entry
                                                                                                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                                                                                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                              360. Bundle.entry:serviceRequest.fullUrl
                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                              The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                                                                                              fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                362. Bundle.entry:serviceRequest.resource
                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

                                                                                                                                                                                                                                                                                                ShortA service request in an Australian healthcare context
                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                TypeServiceRequest(AU eRequesting Diagnostic Request)
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                Alternate Namesdiagnostic request, referral, referral request, transfer of care request
                                                                                                                                                                                                                                                                                                364. Bundle.entry:serviceRequest.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
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                366. Bundle.entry:serviceRequest.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.

                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                368. Bundle.entry:serviceRequest.search.extension
                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                370. Bundle.entry:serviceRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                372. Bundle.entry:serviceRequest.search.mode
                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                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.

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

                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                374. Bundle.entry:serviceRequest.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.

                                                                                                                                                                                                                                                                                                See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                Typedecimal
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                376. Bundle.entry:serviceRequest.request
                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                378. Bundle.entry:serviceRequest.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.

                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                380. Bundle.entry:serviceRequest.request.extension
                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                382. Bundle.entry:serviceRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                384. Bundle.entry:serviceRequest.request.method
                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                ShortPOST (create only)
                                                                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                                                                In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                                  Fixed ValuePOST
                                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                  386. Bundle.entry:serviceRequest.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
                                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    388. Bundle.entry:serviceRequest.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
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    390. Bundle.entry:serviceRequest.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                    Definition

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

                                                                                                                                                                                                                                                                                                    ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    392. Bundle.entry:serviceRequest.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
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    394. Bundle.entry:serviceRequest.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
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    396. Bundle.entry:serviceRequest.response
                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                    ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                    This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    398. Bundle.entry:serviceRequest.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.

                                                                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                    400. Bundle.entry:serviceRequest.response.extension
                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                    402. Bundle.entry:serviceRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                    404. Bundle.entry:serviceRequest.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
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    406. Bundle.entry:serviceRequest.response.location
                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                    The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                    ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    408. Bundle.entry:serviceRequest.response.etag
                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                    The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    410. Bundle.entry:serviceRequest.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                    412. Bundle.entry:serviceRequest.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.

                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                    TypeResource
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                    414. Bundle.entry:taskGroup
                                                                                                                                                                                                                                                                                                    Slice NametaskGroup
                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                                                                                      SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                      416. Bundle.entry:taskGroup.id
                                                                                                                                                                                                                                                                                                      Definition

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

                                                                                                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                      418. Bundle.entry:taskGroup.extension
                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                      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 manageable, 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.

                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                      420. Bundle.entry:taskGroup.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                      422. Bundle.entry:taskGroup.link
                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                      A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                      ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                                                                                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                      424. Bundle.entry:taskGroup.fullUrl
                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                      The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                                                                                                      fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        426. Bundle.entry:taskGroup.resource
                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                        A task to be performed.

                                                                                                                                                                                                                                                                                                        ShortA task to be performed
                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                        TypeTask(AU eRequesting Task Group)
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                        428. Bundle.entry:taskGroup.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
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        430. Bundle.entry:taskGroup.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.

                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                        432. Bundle.entry:taskGroup.search.extension
                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                        434. Bundle.entry:taskGroup.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                        436. Bundle.entry:taskGroup.search.mode
                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                        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.

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

                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        438. Bundle.entry:taskGroup.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.

                                                                                                                                                                                                                                                                                                        See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                        Typedecimal
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        440. Bundle.entry:taskGroup.request
                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                        ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                        This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        442. Bundle.entry:taskGroup.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.

                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                        444. Bundle.entry:taskGroup.request.extension
                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                        446. Bundle.entry:taskGroup.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                        448. Bundle.entry:taskGroup.request.method
                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                        ShortPOST (create only)
                                                                                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                                                                                        In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                        HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                                          Fixed ValuePOST
                                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                          450. Bundle.entry:taskGroup.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
                                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            452. Bundle.entry:taskGroup.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
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            454. Bundle.entry:taskGroup.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                            Definition

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

                                                                                                                                                                                                                                                                                                            ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            456. Bundle.entry:taskGroup.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
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            458. Bundle.entry:taskGroup.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
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            460. Bundle.entry:taskGroup.response
                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                            ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                            This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            462. Bundle.entry:taskGroup.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.

                                                                                                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                            464. Bundle.entry:taskGroup.response.extension
                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                            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 manageable, 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.

                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                            466. Bundle.entry:taskGroup.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                            468. Bundle.entry:taskGroup.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
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            470. Bundle.entry:taskGroup.response.location
                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                            The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                            ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            472. Bundle.entry:taskGroup.response.etag
                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                            The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            474. Bundle.entry:taskGroup.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                            476. Bundle.entry:taskGroup.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.

                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                            TypeResource
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                            478. Bundle.entry:taskDiagnosticRequest
                                                                                                                                                                                                                                                                                                            Slice NametaskDiagnosticRequest
                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                            Control1..*
                                                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                                                                                              SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                              480. Bundle.entry:taskDiagnosticRequest.id
                                                                                                                                                                                                                                                                                                              Definition

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

                                                                                                                                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                              482. Bundle.entry:taskDiagnosticRequest.extension
                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                              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 manageable, 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.

                                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                              484. Bundle.entry:taskDiagnosticRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                              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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                              486. Bundle.entry:taskDiagnosticRequest.link
                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                              A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                              ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                                                                                                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                              488. Bundle.entry:taskDiagnosticRequest.fullUrl
                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                              The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                                                                                                              fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                490. Bundle.entry:taskDiagnosticRequest.resource
                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                A task to be performed.

                                                                                                                                                                                                                                                                                                                ShortA task to be performed
                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                TypeTask(AU eRequesting Task Diagnostic Request)
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                492. Bundle.entry:taskDiagnosticRequest.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
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                494. Bundle.entry:taskDiagnosticRequest.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.

                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                496. Bundle.entry:taskDiagnosticRequest.search.extension
                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                498. Bundle.entry:taskDiagnosticRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                500. Bundle.entry:taskDiagnosticRequest.search.mode
                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                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.

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

                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                502. Bundle.entry:taskDiagnosticRequest.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.

                                                                                                                                                                                                                                                                                                                See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                Typedecimal
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                504. Bundle.entry:taskDiagnosticRequest.request
                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                506. Bundle.entry:taskDiagnosticRequest.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.

                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                508. Bundle.entry:taskDiagnosticRequest.request.extension
                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                510. Bundle.entry:taskDiagnosticRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                512. Bundle.entry:taskDiagnosticRequest.request.method
                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                ShortPOST (create only)
                                                                                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                                                                                In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                                HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                                                  Fixed ValuePOST
                                                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                  514. Bundle.entry:taskDiagnosticRequest.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
                                                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    516. Bundle.entry:taskDiagnosticRequest.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
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    518. Bundle.entry:taskDiagnosticRequest.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                                    Definition

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

                                                                                                                                                                                                                                                                                                                    ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    520. Bundle.entry:taskDiagnosticRequest.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
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    522. Bundle.entry:taskDiagnosticRequest.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
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    524. Bundle.entry:taskDiagnosticRequest.response
                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                    ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                    This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    526. Bundle.entry:taskDiagnosticRequest.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.

                                                                                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                    528. Bundle.entry:taskDiagnosticRequest.response.extension
                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                    530. Bundle.entry:taskDiagnosticRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                    532. Bundle.entry:taskDiagnosticRequest.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
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    534. Bundle.entry:taskDiagnosticRequest.response.location
                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                    The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                                    ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    536. Bundle.entry:taskDiagnosticRequest.response.etag
                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                    The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    538. Bundle.entry:taskDiagnosticRequest.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                    540. Bundle.entry:taskDiagnosticRequest.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.

                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                    TypeResource
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                    542. Bundle.entry:encounter
                                                                                                                                                                                                                                                                                                                    Slice Nameencounter
                                                                                                                                                                                                                                                                                                                    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..1
                                                                                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                                                                                                      SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                      544. Bundle.entry:encounter.id
                                                                                                                                                                                                                                                                                                                      Definition

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

                                                                                                                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                                      546. Bundle.entry:encounter.extension
                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                      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 manageable, 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.

                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                      548. Bundle.entry:encounter.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                      550. Bundle.entry:encounter.link
                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                      A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                                      ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                                                                                                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                      552. Bundle.entry:encounter.fullUrl
                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                      The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                                                                                                                      fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        554. Bundle.entry:encounter.resource
                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                        An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

                                                                                                                                                                                                                                                                                                                        ShortAn encounter in an Australian healthcare context
                                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                                        TypeEncounter(AU eRequesting Encounter)
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                        Alternate NamesVisit
                                                                                                                                                                                                                                                                                                                        556. Bundle.entry:encounter.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
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        558. Bundle.entry:encounter.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.

                                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                        560. Bundle.entry:encounter.search.extension
                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                        562. Bundle.entry:encounter.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                        564. Bundle.entry:encounter.search.mode
                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                        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.

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

                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        566. Bundle.entry:encounter.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.

                                                                                                                                                                                                                                                                                                                        See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                        Typedecimal
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        568. Bundle.entry:encounter.request
                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                        ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                                        This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        570. Bundle.entry:encounter.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.

                                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                        572. Bundle.entry:encounter.request.extension
                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                        574. Bundle.entry:encounter.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                        576. Bundle.entry:encounter.request.method
                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                        ShortPOST (create only)
                                                                                                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                                                                                                        In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                                        HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                                                          Fixed ValuePOST
                                                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                          578. Bundle.entry:encounter.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
                                                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            580. Bundle.entry:encounter.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
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            582. Bundle.entry:encounter.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                                            Definition

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

                                                                                                                                                                                                                                                                                                                            ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            584. Bundle.entry:encounter.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
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            586. Bundle.entry:encounter.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
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            588. Bundle.entry:encounter.response
                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                            ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                            This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            590. Bundle.entry:encounter.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.

                                                                                                                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                                            592. Bundle.entry:encounter.response.extension
                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                            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 manageable, 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.

                                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                            594. Bundle.entry:encounter.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                            596. Bundle.entry:encounter.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
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            598. Bundle.entry:encounter.response.location
                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                            The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                                            ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            600. Bundle.entry:encounter.response.etag
                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                            The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            602. Bundle.entry:encounter.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                            604. Bundle.entry:encounter.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.

                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                            TypeResource
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                            606. Bundle.entry:coverage
                                                                                                                                                                                                                                                                                                                            Slice Namecoverage
                                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                                                                                                              SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                              608. Bundle.entry:coverage.id
                                                                                                                                                                                                                                                                                                                              Definition

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

                                                                                                                                                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                                              610. Bundle.entry:coverage.extension
                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                              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 manageable, 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.

                                                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                              612. Bundle.entry:coverage.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                              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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                              614. Bundle.entry:coverage.link
                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                              A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                                              ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                                                                                                                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                              616. Bundle.entry:coverage.fullUrl
                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                              The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                                                                                                                              fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                618. Bundle.entry:coverage.resource
                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

                                                                                                                                                                                                                                                                                                                                ShortInsurance or medical plan or a payment agreement
                                                                                                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                                                                                                The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

                                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                                TypeCoverage(AU eRequesting Coverage)
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                620. Bundle.entry:coverage.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
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                622. Bundle.entry:coverage.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.

                                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                624. Bundle.entry:coverage.search.extension
                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                626. Bundle.entry:coverage.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                628. Bundle.entry:coverage.search.mode
                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                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.

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

                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                630. Bundle.entry:coverage.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.

                                                                                                                                                                                                                                                                                                                                See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                Typedecimal
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                632. Bundle.entry:coverage.request
                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                                This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                634. Bundle.entry:coverage.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.

                                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                636. Bundle.entry:coverage.request.extension
                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                638. Bundle.entry:coverage.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                640. Bundle.entry:coverage.request.method
                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                ShortPOST (create only)
                                                                                                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                                                                                                In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                                                HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                                                                  Fixed ValuePOST
                                                                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                  642. Bundle.entry:coverage.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
                                                                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    644. Bundle.entry:coverage.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
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    646. Bundle.entry:coverage.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                                                    Definition

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

                                                                                                                                                                                                                                                                                                                                    ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    648. Bundle.entry:coverage.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
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    650. Bundle.entry:coverage.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
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    652. Bundle.entry:coverage.response
                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                    ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                    This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    654. Bundle.entry:coverage.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.

                                                                                                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                                    656. Bundle.entry:coverage.response.extension
                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                    658. Bundle.entry:coverage.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                    660. Bundle.entry:coverage.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
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    662. Bundle.entry:coverage.response.location
                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                    The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                                                    ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    664. Bundle.entry:coverage.response.etag
                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                    The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    666. Bundle.entry:coverage.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                    668. Bundle.entry:coverage.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.

                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                    TypeResource
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                    670. Bundle.entry:clinicalContextDocument
                                                                                                                                                                                                                                                                                                                                    Slice NameclinicalContextDocument
                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                                                                                                                      SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                                                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                                                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                      672. Bundle.entry:clinicalContextDocument.id
                                                                                                                                                                                                                                                                                                                                      Definition

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

                                                                                                                                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                                                      674. Bundle.entry:clinicalContextDocument.extension
                                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                                      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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                      676. Bundle.entry:clinicalContextDocument.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                      678. Bundle.entry:clinicalContextDocument.link
                                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                                      A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                                                      ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                                                                                                                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                      680. Bundle.entry:clinicalContextDocument.fullUrl
                                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                                      The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                                                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                                                                                                                                      fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        682. Bundle.entry:clinicalContextDocument.resource
                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                        A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

                                                                                                                                                                                                                                                                                                                                        ShortA reference to a document
                                                                                                                                                                                                                                                                                                                                        Comments

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

                                                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                                                        TypeDocumentReference(AU eRequesting Clinical Context DocumentReference)
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                        684. Bundle.entry:clinicalContextDocument.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
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        686. Bundle.entry:clinicalContextDocument.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.

                                                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                        688. Bundle.entry:clinicalContextDocument.search.extension
                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                        690. Bundle.entry:clinicalContextDocument.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                        692. Bundle.entry:clinicalContextDocument.search.mode
                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                        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.

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

                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        694. Bundle.entry:clinicalContextDocument.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.

                                                                                                                                                                                                                                                                                                                                        See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                                        Typedecimal
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        696. Bundle.entry:clinicalContextDocument.request
                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                        ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                                                        This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        698. Bundle.entry:clinicalContextDocument.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.

                                                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                        700. Bundle.entry:clinicalContextDocument.request.extension
                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                        702. Bundle.entry:clinicalContextDocument.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                        704. Bundle.entry:clinicalContextDocument.request.method
                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                        ShortPOST (create only)
                                                                                                                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                                                                                                                        In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                                                        HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                                                                          Fixed ValuePOST
                                                                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                          706. Bundle.entry:clinicalContextDocument.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
                                                                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            708. Bundle.entry:clinicalContextDocument.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
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            710. Bundle.entry:clinicalContextDocument.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                                                            Definition

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

                                                                                                                                                                                                                                                                                                                                            ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            712. Bundle.entry:clinicalContextDocument.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
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            714. Bundle.entry:clinicalContextDocument.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
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            716. Bundle.entry:clinicalContextDocument.response
                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                            ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                            This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            718. Bundle.entry:clinicalContextDocument.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.

                                                                                                                                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                                                            720. Bundle.entry:clinicalContextDocument.response.extension
                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                            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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                            722. Bundle.entry:clinicalContextDocument.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                            724. Bundle.entry:clinicalContextDocument.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
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            726. Bundle.entry:clinicalContextDocument.response.location
                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                            The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                                                            ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            728. Bundle.entry:clinicalContextDocument.response.etag
                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                            The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            730. Bundle.entry:clinicalContextDocument.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                            732. Bundle.entry:clinicalContextDocument.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.

                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                            TypeResource
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                            734. Bundle.entry:communicationRequest
                                                                                                                                                                                                                                                                                                                                            Slice NamecommunicationRequest
                                                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                                                                                                                              SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                                                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                              736. Bundle.entry:communicationRequest.id
                                                                                                                                                                                                                                                                                                                                              Definition

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

                                                                                                                                                                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                                                              738. Bundle.entry:communicationRequest.extension
                                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                                              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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                              740. Bundle.entry:communicationRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                              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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                              742. Bundle.entry:communicationRequest.link
                                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                                              A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                                                              ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                                                                                                                                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                              744. Bundle.entry:communicationRequest.fullUrl
                                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                                              The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                                                                                                                                              fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                746. Bundle.entry:communicationRequest.resource
                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

                                                                                                                                                                                                                                                                                                                                                ShortA request for information to be sent to a receiver
                                                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                                                TypeCommunicationRequest(AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Urgent Provider, AU eRequesting CommunicationRequest Patient)
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                748. Bundle.entry:communicationRequest.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
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                750. Bundle.entry:communicationRequest.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.

                                                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                752. Bundle.entry:communicationRequest.search.extension
                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                754. Bundle.entry:communicationRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                756. Bundle.entry:communicationRequest.search.mode
                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                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.

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

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                758. Bundle.entry:communicationRequest.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.

                                                                                                                                                                                                                                                                                                                                                See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                                Typedecimal
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                760. Bundle.entry:communicationRequest.request
                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                                                This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                762. Bundle.entry:communicationRequest.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.

                                                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                764. Bundle.entry:communicationRequest.request.extension
                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                766. Bundle.entry:communicationRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                768. Bundle.entry:communicationRequest.request.method
                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                ShortPOST (create only)
                                                                                                                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                                                                                                                In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                                                                HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                                                                                  Fixed ValuePOST
                                                                                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                  770. Bundle.entry:communicationRequest.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
                                                                                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    772. Bundle.entry:communicationRequest.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
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    774. Bundle.entry:communicationRequest.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                                                                    Definition

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

                                                                                                                                                                                                                                                                                                                                                    ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    776. Bundle.entry:communicationRequest.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
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    778. Bundle.entry:communicationRequest.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
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    780. Bundle.entry:communicationRequest.response
                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                    This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    782. Bundle.entry:communicationRequest.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.

                                                                                                                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                                                    784. Bundle.entry:communicationRequest.response.extension
                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                    786. Bundle.entry:communicationRequest.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                    788. Bundle.entry:communicationRequest.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
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    790. Bundle.entry:communicationRequest.response.location
                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                    The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                                                                    ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    792. Bundle.entry:communicationRequest.response.etag
                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                    The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    794. Bundle.entry:communicationRequest.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                    796. Bundle.entry:communicationRequest.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.

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                    TypeResource
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                    798. Bundle.entry:supportingObservation
                                                                                                                                                                                                                                                                                                                                                    Slice NamesupportingObservation
                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                    Obligations
                                                                                                                                                                                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                                                                                                                                                                                      SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                      SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                      SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                                                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                                                                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                                                                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                      800. Bundle.entry:supportingObservation.id
                                                                                                                                                                                                                                                                                                                                                      Definition

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

                                                                                                                                                                                                                                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                                                                      802. Bundle.entry:supportingObservation.extension
                                                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                                                      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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                      Summaryfalse
                                                                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                      804. Bundle.entry:supportingObservation.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                      806. Bundle.entry:supportingObservation.link
                                                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                                                      A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                                                                      ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                                                                      Control0..*
                                                                                                                                                                                                                                                                                                                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                      808. Bundle.entry:supportingObservation.fullUrl
                                                                                                                                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                                                                                                                                      The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                                                                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                                                                                                                                                      fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                      Obligations
                                                                                                                                                                                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                                                                                                                                                                                        SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                        SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                        SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        810. Bundle.entry:supportingObservation.resource
                                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                                        The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                                                                                                                                                                                                                                                                                        ShortA resource in the bundle
                                                                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                                                                        TypeObservation
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        812. Bundle.entry:supportingObservation.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
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        814. Bundle.entry:supportingObservation.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.

                                                                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                                        816. Bundle.entry:supportingObservation.search.extension
                                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                        818. Bundle.entry:supportingObservation.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                        820. Bundle.entry:supportingObservation.search.mode
                                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                                        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.

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

                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        822. Bundle.entry:supportingObservation.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.

                                                                                                                                                                                                                                                                                                                                                        See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                                                        Typedecimal
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        824. Bundle.entry:supportingObservation.request
                                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                        ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                                                                                                                                        This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        826. Bundle.entry:supportingObservation.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.

                                                                                                                                                                                                                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                                        828. Bundle.entry:supportingObservation.request.extension
                                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                                        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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                        830. Bundle.entry:supportingObservation.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                        Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                        832. Bundle.entry:supportingObservation.request.method
                                                                                                                                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                        ShortPOST (create only)
                                                                                                                                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                                                                                                                                        In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                                                                        HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                                                                        Typecode
                                                                                                                                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                        Obligations
                                                                                                                                                                                                                                                                                                                                                          ObligationsActor
                                                                                                                                                                                                                                                                                                                                                          SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                          SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                          SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                                                                                                                                                                                          Fixed ValuePOST
                                                                                                                                                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                          834. Bundle.entry:supportingObservation.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
                                                                                                                                                                                                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                          Obligations
                                                                                                                                                                                                                                                                                                                                                            ObligationsActor
                                                                                                                                                                                                                                                                                                                                                            SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                            SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                            SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            836. Bundle.entry:supportingObservation.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
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            838. Bundle.entry:supportingObservation.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                                                                            Definition

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

                                                                                                                                                                                                                                                                                                                                                            ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            840. Bundle.entry:supportingObservation.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
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            842. Bundle.entry:supportingObservation.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
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            844. Bundle.entry:supportingObservation.response
                                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                            ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                                            This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                                                                            TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            846. Bundle.entry:supportingObservation.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.

                                                                                                                                                                                                                                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                                                                            848. Bundle.entry:supportingObservation.response.extension
                                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                                            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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Summaryfalse
                                                                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                            850. Bundle.entry:supportingObservation.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Requirements

                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                            Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                            852. Bundle.entry:supportingObservation.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
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            854. Bundle.entry:supportingObservation.response.location
                                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                                            The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                                                                            ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                                            Typeuri
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            856. Bundle.entry:supportingObservation.response.etag
                                                                                                                                                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                                                                                                                                                            The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            858. Bundle.entry:supportingObservation.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                                            Typeinstant
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                            860. Bundle.entry:supportingObservation.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.

                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                                                                                                                                                            TypeResource
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                                                                                                                                                            862. Bundle.entry:location
                                                                                                                                                                                                                                                                                                                                                            Slice Namelocation
                                                                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                            Obligations
                                                                                                                                                                                                                                                                                                                                                              ObligationsActor
                                                                                                                                                                                                                                                                                                                                                              SHALL:populate-if-knownAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                              SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                              SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                                                                                                                                                                                                                                                                                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
                                                                                                                                                                                                                                                                                                                                                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                              864. Bundle.entry:location.id
                                                                                                                                                                                                                                                                                                                                                              Definition

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

                                                                                                                                                                                                                                                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                                                                              866. Bundle.entry:location.extension
                                                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                                                              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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                              Summaryfalse
                                                                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                              868. Bundle.entry:location.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                              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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                                                              Requirements

                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                              Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                              870. Bundle.entry:location.link
                                                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                                                              A series of links that provide context to this entry.

                                                                                                                                                                                                                                                                                                                                                              ShortLinks related to this entry
                                                                                                                                                                                                                                                                                                                                                              Control0..*
                                                                                                                                                                                                                                                                                                                                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                              872. Bundle.entry:location.fullUrl
                                                                                                                                                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                                                                                                                                                              The Absolute URL for the resource. 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. 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.
                                                                                                                                                                                                                                                                                                                                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                                                                                                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                                                                                                                                                              fullUrl might 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 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, 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).

                                                                                                                                                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                                                                                                                                                              Typeuri
                                                                                                                                                                                                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                              Obligations
                                                                                                                                                                                                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                                                                                                                                                                                                SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                                SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                                SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                874. Bundle.entry:location.resource
                                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                                The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                                                                                                                                                                                                                                                                                                                                                ShortA resource in the bundle
                                                                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                                                                TypeLocation
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                876. Bundle.entry:location.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
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                878. Bundle.entry:location.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.

                                                                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                                880. Bundle.entry:location.search.extension
                                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                                882. Bundle.entry:location.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                                884. Bundle.entry:location.search.mode
                                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                                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.

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

                                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                886. Bundle.entry:location.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.

                                                                                                                                                                                                                                                                                                                                                                See Patient Match for the EMPI search which relates to this element.

                                                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                                                Typedecimal
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                888. Bundle.entry:location.request
                                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                                ShortAdditional execution information (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                                                                                                                                                                This element is affected by the following invariants: bdl-3
                                                                                                                                                                                                                                                                                                                                                                TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                890. Bundle.entry:location.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.

                                                                                                                                                                                                                                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                                892. Bundle.entry:location.request.extension
                                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                                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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                                894. Bundle.entry:location.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                                ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                                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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                                                                                                                                                                Requirements

                                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                                Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                                896. Bundle.entry:location.request.method
                                                                                                                                                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                                ShortPOST (create only)
                                                                                                                                                                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                                                                                                                                                                In an AU eRequesting diagnostic request submission an entry only creates a resource (POST, optionally with ifNoneExist) or conditionally updates one by identifier (PUT). Read and delete style interactions (GET, HEAD, DELETE, PATCH) are not permitted; although the element retains the base FHIR HTTPVerb value set, invariant au-ereq-bundle-07 restricts the permitted values to POST and PUT.

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

                                                                                                                                                                                                                                                                                                                                                                HTTP verbs (in the HTTP command line). See HTTP rfc for details.

                                                                                                                                                                                                                                                                                                                                                                Typecode
                                                                                                                                                                                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                                Obligations
                                                                                                                                                                                                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                                                                                                                                                                                                  SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                                  SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                                  SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                                                                                                                                                                                                  Fixed ValuePOST
                                                                                                                                                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                  898. Bundle.entry:location.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
                                                                                                                                                                                                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                                                                                                                                                  Obligations
                                                                                                                                                                                                                                                                                                                                                                    ObligationsActor
                                                                                                                                                                                                                                                                                                                                                                    SHALL:populateAU eRequesting Placer
                                                                                                                                                                                                                                                                                                                                                                    SHALL:handleAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                                    SHALL:able-to-populateAU eRequesting Server
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    900. Bundle.entry:location.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
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    902. Bundle.entry:location.request.ifModifiedSince
                                                                                                                                                                                                                                                                                                                                                                    Definition

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

                                                                                                                                                                                                                                                                                                                                                                    ShortFor managing cache currency
                                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    904. Bundle.entry:location.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
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    906. Bundle.entry:location.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
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    908. Bundle.entry:location.response
                                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                    ShortResults of execution (transaction/batch/history)
                                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                                    This element is affected by the following invariants: bdl-4
                                                                                                                                                                                                                                                                                                                                                                    TypeBackboneElement
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    910. Bundle.entry:location.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.

                                                                                                                                                                                                                                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                                                                    912. Bundle.entry:location.response.extension
                                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                                    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 manageable, 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.

                                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                                    914. Bundle.entry:location.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 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 manageable, 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).

                                                                                                                                                                                                                                                                                                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                                                                                                                                                                                                                                    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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                                                                                                                                                                                                                                    916. Bundle.entry:location.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
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    918. Bundle.entry:location.response.location
                                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                                    The location header created by processing this operation, populated if the operation returns a location.

                                                                                                                                                                                                                                                                                                                                                                    ShortThe location (if the operation returns a location)
                                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    920. Bundle.entry:location.response.etag
                                                                                                                                                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                                                                                                                                                    The Etag for the resource, if 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
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    922. Bundle.entry:location.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 (meta.lastUpdated) if a resource is included.

                                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                                    Typeinstant
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                                                                                                                                                    924. Bundle.entry:location.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.

                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                                                                                                                                                    TypeResource
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    926. 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
                                                                                                                                                                                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))