Smart Health Checks
0.3.0 - ci-build Australia flag

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

Resource Profile: SmartHealthChecksExtractBundle - Detailed Descriptions

Draft as of 2025-09-17

Definitions for the SHCExtractBundle 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))
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:processSHC Host FHIR Server
    SHALL:populateSHC App
    Summarytrue
    Fixed Valuetransaction
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. 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.

    Control10..1
    Typeinstant
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Obligations
      ObligationsActor
      SHALL:populateSHC App
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. 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
      Control10..*
      TypeBackboneElement
      Is Modifierfalse
      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 Closed, and can be differentiated using the following discriminators:
      • value @ request.method
      • 10. 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())
        12. Bundle.entry:post
        Slice Namepost
        Definition

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

        ShortEntries for creating new resourcesEntry in the bundle - will have a resource or information
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActor
          SHALL:processSHC Host FHIR Server
          SHALL:populateSHC App
          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())
          14. Bundle.entry:post.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())
          16. Bundle.entry:post.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:processSHC Host FHIR Server
            SHALL:populateSHC App
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            18. Bundle.entry:post.resource
            Definition

            Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.


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

            ShortAn allergy or intolerance statement in an Australian healthcare contextA resource in the bundle
            Comments

            Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

            Control10..1
            TypeChoice of: AllergyIntolerance(Smart Health Checks AllergyIntolerance), Condition(Smart Health Checks Condition), Immunization(Smart Health Checks Immunization), MedicationStatement(Smart Health Checks MedicationStatement), Observation(Smart Health Checks Blood Pressure, Smart Health Checks Body Height, Smart Health Checks Body Weight, Smart Health Checks Heart Rate, Smart Health Checks Heart Rhythm, Smart Health Checks Smoking Status, Smart Health Checks Waist Circumference, Smart Health Checks Head Circumference), Resource
            Is Modifierfalse
            Must Supporttrue
            Must Support TypesNo must-support rules about the choice of types/profiles
            Obligations
              ObligationsActor
              SHALL:processSHC Host FHIR Server
              SHALL:populateSHC App
              Summarytrue
              Alternate NamesAllergy, Intolerance, Adverse Reaction
              20. Bundle.entry:post.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
              Must Supporttrue
              Obligations
                ObligationsActor
                SHALL:processSHC Host FHIR Server
                SHALL:populateSHC App
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                22. Bundle.entry:post.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())
                24. Bundle.entry:post.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.

                ShortGET | HEAD | POST | PUT | DELETE | PATCH
                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:processSHC Host FHIR Server
                  SHALL:populateSHC App
                  Summarytrue
                  Fixed ValuePOST
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  26. Bundle.entry:post.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:processSHC Host FHIR Server
                    SHALL:populateSHC App
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    28. Bundle.entry:patch
                    Slice Namepatch
                    Definition

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

                    ShortEntries for patching existing resourcesEntry in the bundle - will have a resource or information
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Obligations
                      ObligationsActor
                      SHALL:processSHC Host FHIR Server
                      SHALL:populateSHC App
                      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:patch.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:patch.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:processSHC Host FHIR Server
                        SHALL:populateSHC App
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        34. Bundle.entry:patch.resource
                        Definition

                        This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.


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

                        ShortParameters for patching elements supported in Smart Health ChecksA resource in the bundle
                        Comments

                        The parameters that may be used are defined by the OperationDefinition resource.

                        Control10..1
                        TypeParametersResource(Smart Health Checks Patch)
                        Is Modifierfalse
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:processSHC Host FHIR Server
                          SHALL:populateSHC App
                          Summaryfalse
                          36. Bundle.entry:patch.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
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            SHALL:processSHC Host FHIR Server
                            SHALL:populateSHC App
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            38. Bundle.entry:patch.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:patch.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.

                            ShortGET | HEAD | POST | PUT | DELETE | PATCH
                            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:processSHC Host FHIR Server
                              SHALL:populateSHC App
                              Summarytrue
                              Fixed ValuePATCH
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              42. Bundle.entry:patch.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:processSHC Host FHIR Server
                                SHALL:populateSHC App
                                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
                                2. Bundle.type
                                Must Supporttrue
                                Obligations
                                  ObligationsActor
                                  SHALL:processSHC Host FHIR Server
                                  SHALL:populateSHC App
                                  Fixed Valuetransaction
                                  4. Bundle.timestamp
                                  Control1..?
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActor
                                    SHALL:populateSHC App
                                    6. Bundle.entry
                                    Control1..?
                                    SlicingThis element introduces a set of slices on Bundle.entry. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                    • value @ request.method
                                    • 8. Bundle.entry:post
                                      Slice Namepost
                                      ShortEntries for creating new resources
                                      Control0..*
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        SHALL:processSHC Host FHIR Server
                                        SHALL:populateSHC App
                                        10. Bundle.entry:post.fullUrl
                                        Control1..?
                                        Must Supporttrue
                                        Obligations
                                          ObligationsActor
                                          SHALL:processSHC Host FHIR Server
                                          SHALL:populateSHC App
                                          12. Bundle.entry:post.resource
                                          Control1..?
                                          TypeChoice of: AllergyIntolerance(Smart Health Checks AllergyIntolerance), Condition(Smart Health Checks Condition), Immunization(Smart Health Checks Immunization), MedicationStatement(Smart Health Checks MedicationStatement), Observation(Smart Health Checks Blood Pressure, Smart Health Checks Body Height, Smart Health Checks Body Weight, Smart Health Checks Heart Rate, Smart Health Checks Heart Rhythm, Smart Health Checks Smoking Status, Smart Health Checks Waist Circumference, Smart Health Checks Head Circumference)
                                          Must Supporttrue
                                          Must Support TypesNo must-support rules about the choice of types/profiles
                                          Obligations
                                            ObligationsActor
                                            SHALL:processSHC Host FHIR Server
                                            SHALL:populateSHC App
                                            14. Bundle.entry:post.request
                                            Control1..?
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActor
                                              SHALL:processSHC Host FHIR Server
                                              SHALL:populateSHC App
                                              16. Bundle.entry:post.request.method
                                              Must Supporttrue
                                              Obligations
                                                ObligationsActor
                                                SHALL:processSHC Host FHIR Server
                                                SHALL:populateSHC App
                                                Fixed ValuePOST
                                                18. Bundle.entry:post.request.url
                                                Must Supporttrue
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:processSHC Host FHIR Server
                                                  SHALL:populateSHC App
                                                  20. Bundle.entry:patch
                                                  Slice Namepatch
                                                  ShortEntries for patching existing resources
                                                  Control0..*
                                                  Must Supporttrue
                                                  Obligations
                                                    ObligationsActor
                                                    SHALL:processSHC Host FHIR Server
                                                    SHALL:populateSHC App
                                                    22. Bundle.entry:patch.fullUrl
                                                    Control1..?
                                                    Must Supporttrue
                                                    Obligations
                                                      ObligationsActor
                                                      SHALL:processSHC Host FHIR Server
                                                      SHALL:populateSHC App
                                                      24. Bundle.entry:patch.resource
                                                      Control1..?
                                                      TypeParameters(Smart Health Checks Patch)
                                                      Must Supporttrue
                                                      Obligations
                                                        ObligationsActor
                                                        SHALL:processSHC Host FHIR Server
                                                        SHALL:populateSHC App
                                                        26. Bundle.entry:patch.request
                                                        Control1..?
                                                        Must Supporttrue
                                                        Obligations
                                                          ObligationsActor
                                                          SHALL:processSHC Host FHIR Server
                                                          SHALL:populateSHC App
                                                          28. Bundle.entry:patch.request.method
                                                          Must Supporttrue
                                                          Obligations
                                                            ObligationsActor
                                                            SHALL:processSHC Host FHIR Server
                                                            SHALL:populateSHC App
                                                            Fixed ValuePATCH
                                                            30. Bundle.entry:patch.request.url
                                                            Must Supporttrue
                                                            Obligations
                                                              ObligationsActor
                                                              SHALL:processSHC Host FHIR Server
                                                              SHALL:populateSHC App

                                                              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))
                                                              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:processSHC Host FHIR Server
                                                                SHALL:populateSHC App
                                                                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.

                                                                Control1..1
                                                                Typeinstant
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supporttrue
                                                                Obligations
                                                                  ObligationsActor
                                                                  SHALL:populateSHC App
                                                                  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
                                                                  Control1..*
                                                                  TypeBackboneElement
                                                                  Is Modifierfalse
                                                                  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 Closed, and can be differentiated using the following discriminators:
                                                                  • value @ request.method
                                                                  • 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.

                                                                    ShortGET | HEAD | POST | PUT | DELETE | PATCH
                                                                    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:post
                                                                    Slice Namepost
                                                                    Definition

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

                                                                    ShortEntries for creating new resources
                                                                    Control0..*
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    Obligations
                                                                      ObligationsActor
                                                                      SHALL:processSHC Host FHIR Server
                                                                      SHALL:populateSHC App
                                                                      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:post.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:post.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:post.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:post.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:post.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:processSHC Host FHIR Server
                                                                        SHALL:populateSHC App
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        106. Bundle.entry:post.resource
                                                                        Definition

                                                                        Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

                                                                        ShortAn allergy or intolerance statement in an Australian healthcare context
                                                                        Comments

                                                                        Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

                                                                        Control1..1
                                                                        TypeChoice of: AllergyIntolerance(Smart Health Checks AllergyIntolerance), Condition(Smart Health Checks Condition), Immunization(Smart Health Checks Immunization), MedicationStatement(Smart Health Checks MedicationStatement), Observation(Smart Health Checks Blood Pressure, Smart Health Checks Body Height, Smart Health Checks Body Weight, Smart Health Checks Heart Rate, Smart Health Checks Heart Rhythm, Smart Health Checks Smoking Status, Smart Health Checks Waist Circumference, Smart Health Checks Head Circumference)
                                                                        Is Modifierfalse
                                                                        Must Supporttrue
                                                                        Must Support TypesNo must-support rules about the choice of types/profiles
                                                                        Obligations
                                                                          ObligationsActor
                                                                          SHALL:processSHC Host FHIR Server
                                                                          SHALL:populateSHC App
                                                                          Summarytrue
                                                                          Alternate NamesAllergy, Intolerance, Adverse Reaction
                                                                          108. Bundle.entry:post.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:post.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:post.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:post.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:post.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:post.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:post.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
                                                                          Must Supporttrue
                                                                          Obligations
                                                                            ObligationsActor
                                                                            SHALL:processSHC Host FHIR Server
                                                                            SHALL:populateSHC App
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            122. Bundle.entry:post.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:post.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:post.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:post.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.

                                                                            ShortGET | HEAD | POST | PUT | DELETE | PATCH
                                                                            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:processSHC Host FHIR Server
                                                                              SHALL:populateSHC App
                                                                              Summarytrue
                                                                              Fixed ValuePOST
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              130. Bundle.entry:post.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:processSHC Host FHIR Server
                                                                                SHALL:populateSHC App
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                132. Bundle.entry:post.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:post.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:post.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:post.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()))
                                                                                140. Bundle.entry:post.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:post.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:post.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:post.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:post.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:post.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:post.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:post.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:post.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:patch
                                                                                Slice Namepatch
                                                                                Definition

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

                                                                                ShortEntries for patching existing resources
                                                                                Control0..*
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Obligations
                                                                                  ObligationsActor
                                                                                  SHALL:processSHC Host FHIR Server
                                                                                  SHALL:populateSHC App
                                                                                  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:patch.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:patch.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:patch.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:patch.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:patch.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:processSHC Host FHIR Server
                                                                                    SHALL:populateSHC App
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    170. Bundle.entry:patch.resource
                                                                                    Definition

                                                                                    This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

                                                                                    ShortParameters for patching elements supported in Smart Health Checks
                                                                                    Comments

                                                                                    The parameters that may be used are defined by the OperationDefinition resource.

                                                                                    Control1..1
                                                                                    TypeParameters(Smart Health Checks Patch)
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Obligations
                                                                                      ObligationsActor
                                                                                      SHALL:processSHC Host FHIR Server
                                                                                      SHALL:populateSHC App
                                                                                      Summaryfalse
                                                                                      172. Bundle.entry:patch.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:patch.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:patch.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:patch.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:patch.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:patch.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:patch.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
                                                                                      Must Supporttrue
                                                                                      Obligations
                                                                                        ObligationsActor
                                                                                        SHALL:processSHC Host FHIR Server
                                                                                        SHALL:populateSHC App
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        186. Bundle.entry:patch.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:patch.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:patch.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:patch.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.

                                                                                        ShortGET | HEAD | POST | PUT | DELETE | PATCH
                                                                                        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:processSHC Host FHIR Server
                                                                                          SHALL:populateSHC App
                                                                                          Summarytrue
                                                                                          Fixed ValuePATCH
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          194. Bundle.entry:patch.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:processSHC Host FHIR Server
                                                                                            SHALL:populateSHC App
                                                                                            Summarytrue
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            196. Bundle.entry:patch.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:patch.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:patch.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:patch.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()))
                                                                                            204. Bundle.entry:patch.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:patch.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:patch.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:patch.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:patch.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:patch.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:patch.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:patch.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:patch.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.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()))