Class TaskBuilder

Class reporesenting a FHIR Task builder FIXME: Incomplete

Hierarchy

DomainResourceBuilder
- TaskBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new TaskBuilder(): TaskBuilder

Overrides DomainResourceBuilder.constructor
- Defined in src/task-builder.ts:27
Create a new FHIR TaskBuilder

Returns TaskBuilder

Methods

addBasedOn

addBasedOn(reference: Reference): this

- Defined in src/task-builder.ts:139
Adds the reference provided as an argument to the resource's reference array, if a reference referring to the same resource does not already exist in the array

Parameters
- reference: Reference
  
  The reference to be added to the basedOn-array
Returns this

the Builder

addContained

addContained(contained: Resource): this

Inherited from DomainResourceBuilder.addContained
- Defined in src/domain-resource-builder.ts:90
Adds the resource provided as an argument to the resource's contained array, if a resource with that id does not already exist in the array.

throws

{ AlreadyExistsError } If the resource already exists

Parameters
- contained: Resource
  
  The resource to be added to the contained array
Returns this

the Builder

addExtension

addExtension(extension: Extension): this

Inherited from DomainResourceBuilder.addExtension
- Defined in src/domain-resource-builder.ts:134
Adds the extension provided as an argument to the resource's extension array

Parameters
- extension: Extension
  
  The extension to be added to the extension-array
Returns this

the Builder

addIdentifier

addIdentifier(identifier: Identifier): this

- Defined in src/task-builder.ts:84
Appends an identifier to the task, if an identifier within the system does not already exist

throws

{ MissingPropertyError } When the identifier is missing necessary properties

throws

{ AlreadyExistsError } When an identifier in that system already exists on the task

Parameters
- identifier: Identifier
  
  the identifier to be appended
Returns this
- this TaskBuilder

addInput

addInput(input: TaskInput): this

- Defined in src/task-builder.ts:259
Adds the reference provided as an argument to the resource's reference array, if a reference referring to the same resource does not already exist in the array

Parameters
- input: TaskInput
Returns this

the Builder

addModifierExtension

addModifierExtension(modifierExtension: Extension): this

Inherited from DomainResourceBuilder.addModifierExtension
- Defined in src/domain-resource-builder.ts:171
Adds the extension provided as an argument to the resource's modifierExtension array

Parameters
- modifierExtension: Extension
  
  The modifierExtension to be added to the modifierExtension-array
Returns this

the Builder

build

build(): Task

Overrides DomainResourceBuilder.build
- Defined in src/task-builder.ts:307
Builds and returns the task

override

Returns Task
- the task

conflictsWith

conflictsWith(task: Task): boolean

Overrides ResourceBuilder.conflictsWith
- Defined in src/task-builder.ts:278
Returns whether or not the task provided as an argument is in conflict with the task used in the builder

Parameters
- task: Task
  
  The task to test for conflict
Returns boolean

Whether it is in conflict

getAuthoredOn

getAuthoredOn(): dateTime | undefined

- Defined in src/task-builder.ts:197
Returns the authoredOn field of the task if it is set

Returns dateTime | undefined

the authoredOn of the task

getBasedOn

getBasedOn(): Reference[]

- Defined in src/task-builder.ts:105
Returns the basedOn-array

Returns Reference[]

The basedOn-array

getContained

getContained(): Resource[]
getContained(id: id): Resource | undefined

Inherited from DomainResourceBuilder.getContained
- Defined in src/domain-resource-builder.ts:60
Returns either the resource identified by the provided id from the contained array or the entire contained array, if no id is provided

Returns Resource[]

The resource if it exists or the contained-array
Inherited from DomainResourceBuilder.getContained
- Defined in src/domain-resource-builder.ts:61
Parameters
- id: id
Returns Resource | undefined

getExtension

getExtension(url?: uri): Extension[]

Inherited from DomainResourceBuilder.getExtension
- Defined in src/domain-resource-builder.ts:109
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: uri
Returns Extension[]

The extensions if they exists or the extension-array

getId

getId(): id | undefined

Inherited from ResourceBuilder.getId
- Defined in src/resource-builder.ts:59
Returns the resource's id

Returns id | undefined

The resource's id

getIdentifier

getIdentifier(): Identifier[]
getIdentifier(system: uri): Identifier | undefined

- Defined in src/task-builder.ts:55
Returns identifier from specific system if one exists or the identifier-array if no system was provided

Returns Identifier[]

the identifier if it exists
- Defined in src/task-builder.ts:56
Parameters
- system: uri
Returns Identifier | undefined

getImplicitRules

getImplicitRules(): uri | undefined

Inherited from ResourceBuilder.getImplicitRules
- Defined in src/resource-builder.ts:97
Returns the implicitRules-field of the Resource

Returns uri | undefined

The implicitRules-field

getInput

getInput(): TaskInput[]

- Defined in src/task-builder.ts:239
Returns the input-array

Returns TaskInput[]

The input-array

getIntent

getIntent(): TaskIntent

- Defined in src/task-builder.ts:177
Returns the intent field of the task

Returns TaskIntent

the intent of the task

getLanguage

getLanguage(): code | undefined

Inherited from ResourceBuilder.getLanguage
- Defined in src/resource-builder.ts:118
Returns the language-field of the Resource

Returns code | undefined

The language-field

getLastModified

getLastModified(): dateTime | undefined

- Defined in src/task-builder.ts:218
Returns the lastModified field of the task if it is set

Returns dateTime | undefined

the lastModified of the task

getMeta

getMeta(): Meta | undefined

Inherited from ResourceBuilder.getMeta
- Defined in src/resource-builder.ts:78
Returns the meta-field of the Resource

Returns Meta | undefined

The meta-field

getModifierExtension

getModifierExtension(url?: uri): Extension[]

Inherited from DomainResourceBuilder.getModifierExtension
- Defined in src/domain-resource-builder.ts:144
Returns either the modifierExtensions identified by the provided url from the modifierExtension array or the entire modifierExtension array, if no url is provided

Parameters
- Optional url: uri
Returns Extension[]

The modifierExtensions if they exists or the modifierExtension-array

getResourceType

getResourceType(): code | undefined

Inherited from ResourceBuilder.getResourceType
- Defined in src/resource-builder.ts:38
Returns the resourceType-field of the Resource

Returns code | undefined

The resourceType-field

getStatus

getStatus(): TaskStatus

- Defined in src/task-builder.ts:159
Returns the status field of the task

Returns TaskStatus

the code of the task

getText

getText(): Narrative | undefined

Inherited from DomainResourceBuilder.getText
- Defined in src/domain-resource-builder.ts:41
Returns the text-field of the DomainResource

Returns Narrative | undefined

The text-field

Protected make

make(): Task

Overrides DomainResourceBuilder.make
- Defined in src/task-builder.ts:295
Make a new object that implements a FHIR Task

override

Returns Task
- an object that implements FHIR Task

setAuthoredOn

setAuthoredOn(authoredOn?: dateTime): this

- Defined in src/task-builder.ts:207
Set the authoredOn field of the task If no argument is provided, the field will be removed

Parameters
- Optional authoredOn: dateTime
  
  the date to be set as authoredOn
Returns this

this TaskBuilder

setBasedOn

setBasedOn(basedOn?: Reference[]): this

- Defined in src/task-builder.ts:115
Sets the basedOn-array to the provided array If no argument is provided, the field will be removed

Parameters
- Optional basedOn: Reference[]
  
  The array to be set as the basedOn-array
Returns this

the Builder

setContained

setContained(contained?: Resource[]): this

Inherited from DomainResourceBuilder.setContained
- Defined in src/domain-resource-builder.ts:77
Sets the resource's contained-array to the provided array If no argument is provided, the field will be removed

Parameters
- Optional contained: Resource[]
  
  The array to be set as the resource's contained array
Returns this

the Builder

setExtension

setExtension(extension?: Extension[]): this

Inherited from DomainResourceBuilder.setExtension
- Defined in src/domain-resource-builder.ts:122
Sets the resource's 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

Inherited from ResourceBuilder.setId
- Defined in src/resource-builder.ts:69
Sets the resource'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

setIdentifier(identifier?: Identifier[]): this

- Defined in src/task-builder.ts:70
Replaces the identifier array with the provided array If no argument is provided, the field will be removed

Parameters
- Optional identifier: Identifier[]
Returns this
- this TaskBuilder

setImplicitRules

setImplicitRules(implicitRules?: uri): this

Inherited from ResourceBuilder.setImplicitRules
- Defined in src/resource-builder.ts:107
Sets the implicitRules-field of the Resource If no argument is provided, the field will be removed

Parameters
- Optional implicitRules: uri
  
  The value to be set in the implicitRules-field
Returns this
- The builder

setInput

setInput(input?: TaskInput[]): this

- Defined in src/task-builder.ts:249
Sets the input-array to the provided array If no argument is provided, the field will be removed

Parameters
- Optional input: TaskInput[]
  
  The array to be set as the input-array
Returns this

the Builder

setIntent

setIntent(intent: TaskIntent): this

- Defined in src/task-builder.ts:188
Set the intent field of the task If no argument is provided, the field will be removed

Parameters
- intent: TaskIntent
  
  the intent to be set. Must be one of: unknown | proposal | plan | order | original-order | reflex-order | filler-order
Returns this

this TaskBuilder

setLanguage

setLanguage(language?: code): this

Inherited from ResourceBuilder.setLanguage
- Defined in src/resource-builder.ts:128
Sets the language-field of the Resource If no argument is provided, the field will be removed

Parameters
- Optional language: code
Returns this
- The builder

setLastModified

setLastModified(lastModified?: dateTime): this

- Defined in src/task-builder.ts:228
Set the lastModified field of the task If no argument is provided, the field will be removed

Parameters
- Optional lastModified: dateTime
  
  the date to be set as lastModified
Returns this

this TaskBuilder

setMeta

setMeta(meta?: Meta): this

Inherited from ResourceBuilder.setMeta
- Defined in src/resource-builder.ts:88
Sets the meta-field of the Resource If no argument is provided, the field will be removed

Parameters
- Optional meta: Meta
  
  The value to be set in the meta-field
Returns this
- The builder

setModifierExtension

setModifierExtension(modifierExtension?: Extension[]): this

Inherited from DomainResourceBuilder.setModifierExtension
- Defined in src/domain-resource-builder.ts:159
Sets the resource's modifierExtension-array to the provided array If no argument is provided, the field will be removed

Parameters
- Optional modifierExtension: Extension[]
  
  The array to be set as the resource's modifierExtension array
Returns this

the Builder

setResourceType

setResourceType(resourceType?: code): this

Inherited from ResourceBuilder.setResourceType
- Defined in src/resource-builder.ts:48
Sets the resourceType-field of the Resource If no argument is provided, the field will be removed

Parameters
- Optional resourceType: code
  
  The value to be set in the resourceType-field
Returns this
- The builder

setStatus

setStatus(status: TaskStatus): this

- Defined in src/task-builder.ts:168
Set the status field of the task If no argument is provided, the field will be removed

Parameters
- status: TaskStatus
  
  the status to be set
Returns this

setText

setText(text?: Narrative): this

Inherited from DomainResourceBuilder.setText
- Defined in src/domain-resource-builder.ts:51
Sets the text-field of the DomainResource If no argument is provided, the field will be removed

Parameters
- Optional text: Narrative
  
  The value to be set in the text-field
Returns this
- The builder

use

use(task?: Task): this

Overrides DomainResourceBuilder.use
- Defined in src/task-builder.ts:45
Sets a copy of an existing task for this TaskBuilder to allow for manipulation, or interacting with, the task through this TaskBuilder. If no argument is provided, a new Task will be generated

override

Parameters
- Optional task: Task
  
  the task to be set
Returns this

this TaskBuilder

Generated using TypeDoc