Data Model Libraries
    Preparing search index...

    BundleEntryComponent Class

    FHIR Specification

    • Short: Entry in the bundle - will have a resource or information
    • Definition: An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Bundle.entry.link Element

    FHIR Specification

    • Short: Links related to this entry
    • Definition: A series of links that provide context to this entry.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    fullUrl?: UriType

    Bundle.entry.fullUrl Element

    FHIR Specification

    • Short: URI for resource (Absolute URL server address or URI for UUID/OID)
    • 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.
    • Comment: 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).
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resource?: IResource

    Bundle.entry.resource Element

    FHIR Specification

    • Short: A resource in the bundle
    • Definition: The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
    • FHIR Type: Resource
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Bundle.entry.search Element

    FHIR Specification

    • Short: Search related information
    • Definition: Information about the search process that lead to the creation of this entry.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Bundle.entry.request Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Bundle.entry.response Element

    FHIR Specification

    • Short: Results of execution (transaction/batch/history)
    • 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR BundleEntryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | BundleEntryComponent

      BundleEntryComponent data model or undefined for BundleEntryComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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