Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReferenceBuilder

Class representing a FHIR

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addExtension

  • Adds the extension provided as an argument to the resource's extension array

    Parameters

    • extension: Extension

      The resource to be added to the extension array

    Returns this

    the Builder

build

conflictsWith

  • conflictsWith(reference: Reference): boolean

  • Returns whether or not the reference provided as an argument is in conflict with the reference used in the builder

    override

    Parameters

    • reference: Reference

      The reference to test for conflict

    Returns boolean

    Whether it is in conflict

getDisplay

  • getDisplay(): string | undefined

  • Returns the display-field of the Reference

    Returns string | undefined

    The display-field

getExtension

  • Returns either the extensions identified by the provided url from the extension array or the entire extension array, if no url is provided

    Parameters

    • Optional url: url

    Returns Extension[]

    The extensions if they exists or the extension-array

getId

  • getId(): id | undefined

  • Returns the element's id

    Returns id | undefined

    The element's id

getIdentifier

  • Returns the identifier-field of the Reference

    Returns Identifier | undefined

    The identifier-field

getReference

  • getReference(): string | undefined

  • Returns the reference-field of the Reference

    Returns string | undefined

    The reference-field

getType

  • getType(): string | undefined

  • Returns the type-field of the Reference

    Returns string | undefined

    The type-field

Protected make

  • Make a new object that implements a FHIR Reference

    override

    Returns Reference

    • an object that implements FHIR Reference

setDisplay

  • setDisplay(display?: undefined | string): this

  • Sets the display-field of the Reference If no argument is provided, the field will be removed

    Parameters

    • Optional display: undefined | string

      The value to be set in the display-field

    Returns this

    • This ReferenceBuilder

setExtension

  • setExtension(extension?: Extension[]): this

  • Sets the resource'extension-array to the provided array If no argument is provided, the field will be removed

    Parameters

    • Optional extension: Extension[]

      The array to be set as the resource's extension array

    Returns this

    the Builder

setId

  • setId(id?: id): this

  • Sets the element's id to the id provided as an argument If no argument is provided, the field will be removed

    Parameters

    • Optional id: id

      the id to be set

    Returns this

    the Builder

setIdentifier

  • Sets the identifier-field of the Reference If no argument is provided, the field will be removed

    Parameters

    • Optional identifier: Identifier

      The value to be set in the identifier-field

    Returns this

    • This ReferenceBuilder

setReference

  • setReference(reference?: undefined | string): this

  • Sets the reference-field of the Reference If no argument is provided, the field will be removed

    Parameters

    • Optional reference: undefined | string

      The value to be set in the reference-field

    Returns this

    • This ReferenceBuilder

setType

  • setType(type?: undefined | string): this

  • Sets the type-field of the Reference If no argument is provided, the field will be removed

    Parameters

    • Optional type: undefined | string

      The value to be set in the type-field

    Returns this

    • This ReferenceBuilder

use

  • Sets a copy of an existing reference for this builder to allow for manipulation If no argument is provided, a new Reference will be generated

    override

    Parameters

    Returns this

    The builder

Generated using TypeDoc