Data Model Libraries
    Preparing search index...

    BundleEntryResponseComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    status: null | StringType

    Bundle.entry.response.status Element

    FHIR Specification

    • Short: Status response code (text optional)
    • 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.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    location?: UriType

    Bundle.entry.response.location Element

    FHIR Specification

    • Short: The location (if the operation returns a location)
    • Definition: The location header created by processing this operation, populated if the operation returns a location.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    etag?: StringType

    Bundle.entry.response.etag Element

    FHIR Specification

    • Short: The Etag for the resource (if relevant)
    • 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).
    • Comment: Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    lastModified?: InstantType

    Bundle.entry.response.lastModified Element

    FHIR Specification

    • Short: Server's date time modified
    • Definition: The date/time that the resource was modified on the server.
    • Comment: This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    outcome?: IResource

    Bundle.entry.response.outcome Element

    FHIR Specification

    • Short: OperationOutcome with hints and warnings (for batch/transaction)
    • Definition: An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
    • Comment: 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.
    • FHIR Type: Resource
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR BundleEntryResponseComponent

      • OptionaloptSourceField: string

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

      Returns undefined | BundleEntryResponseComponent

      BundleEntryResponseComponent data model or undefined for BundleEntryResponseComponent

      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