Data Model Libraries
    Preparing search index...

    BundleEntryRequestComponent Class

    FHIR Specification

    • Short: Additional execution information (transaction/batch/history)
    • 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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    httpVerbEnum: HttpVerbEnum

    FHIR CodeSystem: HttpVerb

    method: null | EnumCodeType

    Bundle.entry.request.method Element

    FHIR Specification

    • Short: GET | HEAD | POST | PUT | DELETE | PATCH
    • 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.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: HttpVerbEnum

    url: null | UriType

    Bundle.entry.request.url Element

    FHIR Specification

    • Short: URL for HTTP equivalent of this entry
    • Definition: The URL for this entry, relative to the root (the address to which the request is posted).
    • Comment: 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]".
    • FHIR Type: uri
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    ifNoneMatch?: StringType

    Bundle.entry.request.ifNoneMatch Element

    FHIR Specification

    • Short: For managing cache currency
    • Definition: If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    ifModifiedSince?: InstantType

    Bundle.entry.request.ifModifiedSince Element

    FHIR Specification

    • Short: For managing cache currency
    • Definition: Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    ifMatch?: StringType

    Bundle.entry.request.ifMatch Element

    FHIR Specification

    • Short: For managing update contention
    • Definition: Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    ifNoneExist?: StringType

    Bundle.entry.request.ifNoneExist Element

    FHIR Specification

    • Short: For conditional creates
    • 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 "?").
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided BundleEntryRequestComponent JSON to instantiate the BundleEntryRequestComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR BundleEntryRequestComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to BundleEntryRequestComponent

      Returns undefined | BundleEntryRequestComponent

      BundleEntryRequestComponent data model or undefined for BundleEntryRequestComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise