Class CarePlanBuilder

Class representing a FHIR CarePlan builder

Hierarchy

DomainResourceBuilder
- CarePlanBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new CarePlanBuilder(): CarePlanBuilder

Overrides DomainResourceBuilder.constructor
- Defined in src/care-plan-builder.ts:29
Creates a new FHIR CarePlanBuilder

Returns CarePlanBuilder

Methods

_generateIsoDate

_generateIsoDate(): string

- Defined in src/care-plan-builder.ts:395
Public make-method for mocking

Returns string

addActivity

addActivity(activity: CarePlanActivity): this

- Defined in src/care-plan-builder.ts:378
Adds the activity provided as an argument to the resource's activity-array

Parameters
- activity: CarePlanActivity
  
  The activity to be added to the activity-array
Returns this

the Builder

addAddresses

addAddresses(reference: Reference): this

- Defined in src/care-plan-builder.ts:330
Appends an address to the careplan, if an addres within the system does not already exist

throws

{ MissingPropertyError } When the Reference is missing necessary properties

throws

{ AlreadyExistsError } When the Reference is missing necessary properties

Parameters
- reference: Reference
Returns this
- this CarePlanBuilder

addContained

addContained(contained: Resource): this

Inherited from DomainResourceBuilder.addContained
- Defined in src/domain-resource-builder.ts:86
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 element 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:125
Adds the extension provided as an argument to the resource's extension array, if an extension with that url does not already exist in the 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/care-plan-builder.ts:85
Appends an identifier to the careplan, if an identifier within the system does not already exist

throws

{ MissingPropertyError } When identifier is missing necessary properties

throws

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

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

addInstantiatesCanonical

addInstantiatesCanonical(canonical: canonical): this

- Defined in src/care-plan-builder.ts:128
Appends a plan definition canonical reference to the careplan, if it does not already exist

throws

{ AlreadyExistsError } When the canonical already exists on the CarePlan

Parameters
- canonical: canonical
  
  the canonical reference to be appended
Returns this
- this CarePlanBuilder

addModifierExtension

addModifierExtension(modifierExtension: Extension): this

Inherited from DomainResourceBuilder.addModifierExtension
- Defined in src/domain-resource-builder.ts:161
Adds the modifierExtension provided as an argument to the resource's modifierExtension array, if an modifierExtension with that url does not already exist in the array.

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

the Builder

build

build(): CarePlan

Overrides DomainResourceBuilder.build
- Defined in src/care-plan-builder.ts:416
Builds and returns the careplan

Returns CarePlan
- the careplan

conflictsWith

conflictsWith(resource: Resource): boolean

Inherited from ResourceBuilder.conflictsWith
- Defined in src/resource-builder.ts:133
Returns whether or not the resource provided as an argument is in conflict with the resource used in the builder

Parameters
- resource: Resource
  
  The resource to test for conflict
Returns boolean

Whether it is in conflict

getActivity

getActivity(): CarePlanActivity[]
getActivity(id: id): CarePlanActivity | undefined

- Defined in src/care-plan-builder.ts:350
Returns either the carePlanActivity identified by the provided id from the activity-array or the entire activity-array, if no id is provided

Returns CarePlanActivity[]

The carePlanActivity identified by the provided id or the activity-array
- Defined in src/care-plan-builder.ts:351
Parameters
- id: id
Returns CarePlanActivity | undefined

getAddresses

getAddresses(): Reference[]

- Defined in src/care-plan-builder.ts:294
Returns the addresses-field for careplan

Returns Reference[]
- the addresses-field

getAuthor

getAuthor(): Reference

- Defined in src/care-plan-builder.ts:285
Returns the careplan's author

Returns Reference

author - the author of the careplan

getContained

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

Inherited from DomainResourceBuilder.getContained
- Defined in src/domain-resource-builder.ts:57
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:58
Parameters
- id: id
Returns Resource | undefined

getCreated

getCreated(): dateTime

- Defined in src/care-plan-builder.ts:266
Returns the careplan's created field

Returns dateTime

created - the date the careplan's was created

getEncounter

getEncounter(): Reference

- Defined in src/care-plan-builder.ts:247
Returns the careplan's encounter

Returns Reference

encounter - the encounter to which the careplan is related.

getExtension

getExtension(url?: uri): Extension[]

Inherited from DomainResourceBuilder.getExtension
- Defined in src/domain-resource-builder.ts:101
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:56
Returns the resource's id

Returns id | undefined

The resource's id

getIdentifier

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

- Defined in src/care-plan-builder.ts:55
Returns either the identifier identified by the provided system from the identifier-array or the entire identifier array, if no system is provided

Returns Identifier[]

The identifier if it exists or the identifier-array
- Defined in src/care-plan-builder.ts:56
Parameters
- system: uri
Returns Identifier | undefined

getImplicitRules

getImplicitRules(): uri | undefined

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

Returns uri | undefined

The implicitRules-field

getInstantiatesCanonical

getInstantiatesCanonical(): canonical[]

- Defined in src/care-plan-builder.ts:106
Returns all plan definition canonical references for careplan

Returns canonical[]
- the canonicals

getIntent

getIntent(): CarePlanIntent

- Defined in src/care-plan-builder.ts:163
Returns the careplan's intent field. This field is contrained to 'order'

Returns CarePlanIntent
- the intent of the careplan

getLanguage

getLanguage(): code | undefined

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

Returns code | undefined

The language-field

getMeta

getMeta(): Meta | undefined

Inherited from ResourceBuilder.getMeta
- Defined in src/resource-builder.ts:74
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:135
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

getPeriod

getPeriod(): Period | undefined

- Defined in src/care-plan-builder.ts:227
Returns the careplan's period

Returns Period | undefined

period - the period within which the careplan is active

getResourceType

getResourceType(): code | undefined

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

Returns code | undefined

The resourceType-field

getStatus

getStatus(): CarePlanStatus

- Defined in src/care-plan-builder.ts:145
Returns the careplan's status field

Returns CarePlanStatus
- the status of the careplan

getSubject

getSubject(): Reference

- Defined in src/care-plan-builder.ts:209
Returns the careplan's subject

Returns Reference

subject - the subject of the careplan

getText

getText(): Narrative | undefined

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

Returns Narrative | undefined

The text-field

getTitle

getTitle(): string | undefined

- Defined in src/care-plan-builder.ts:191
Returns the carplan's title field

Returns string | undefined

the title of the careplan

Protected make

make(): CarePlan

Overrides DomainResourceBuilder.make
- Defined in src/care-plan-builder.ts:403
Make a new object that implements a FHIR CarePlan

Returns CarePlan
- an object that implements FHIR CarePlan

setActivity

setActivity(activity?: CarePlanActivity[]): this

- Defined in src/care-plan-builder.ts:366
Sets the activity-array to the provided array

Parameters
- Optional activity: CarePlanActivity[]
  
  The array to be set as the action-array
Returns this

the Builder

setAddresses

setAddresses(addresses?: Reference[]): this

- Defined in src/care-plan-builder.ts:303
Replace the addresses array with the provided array

Parameters
- Optional addresses: Reference[]
Returns this
- this CarePlanBuilder

setAuthor

setAuthor(author?: Reference): this

- Defined in src/care-plan-builder.ts:276
Sets the careplan's author field

Parameters
- Optional author: Reference
  
  the author which the careplan refereces
Returns this

this CarePlanBuilder

setContained

setContained(contained?: Resource[]): this

Inherited from DomainResourceBuilder.setContained
- Defined in src/domain-resource-builder.ts:73
Sets the resource's contained-array to the provided array

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

the Builder

setCreated

setCreated(created?: dateTime): this

- Defined in src/care-plan-builder.ts:257
Sets the careplan's created field

Parameters
- Optional created: dateTime
  
  the date the careplan's was created
Returns this

this CarePlanBuilder

setEncounter

setEncounter(encounter?: Reference): this

- Defined in src/care-plan-builder.ts:236
Sets the careplan's encounter field

Parameters
- Optional encounter: Reference
  
  the encounter to which the careplan is related
Returns this

this CarePlanBuilder

setExtension

setExtension(extension?: Extension[]): this

Inherited from DomainResourceBuilder.setExtension
- Defined in src/domain-resource-builder.ts:113
Sets the resource's extension-array to the provided array

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:65
Sets the resource's id to the id provided as an argument

Parameters
- Optional id: id
  
  the id to be set
Returns this

the Builder

setIdentifier

setIdentifier(identifier?: Identifier[]): this

- Defined in src/care-plan-builder.ts:71
Replaces the identifier array with the provided array

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

setImplicitRules

setImplicitRules(implicitRules?: uri): this

Inherited from ResourceBuilder.setImplicitRules
- Defined in src/resource-builder.ts:101
Sets the implicitRules-field of the Resource

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

setInstantiatesCanonical

setInstantiatesCanonical(canonical?: canonical[]): this

- Defined in src/care-plan-builder.ts:115
Replaces the instantiatesCanonical array with the provided array

Parameters
- Optional canonical: canonical[]
  
  the array to be set
Returns this
- this CarePlanBuilder

setIntent

setIntent(intent: CarePlanIntent): this

- Defined in src/care-plan-builder.ts:172
Sets the careplan's intent-field

Parameters
- intent: CarePlanIntent
  
  the intent to be set. Must be one of: draft | active | suspended | completed | entered-in-error | cancelled | unknown
Returns this
- The builder

setLanguage

setLanguage(language?: code): this

Inherited from ResourceBuilder.setLanguage
- Defined in src/resource-builder.ts:121
Sets the language-field of the Resource

Parameters
- Optional language: code
Returns this
- The builder

setMeta

setMeta(meta?: Meta): this

Inherited from ResourceBuilder.setMeta
- Defined in src/resource-builder.ts:83
Sets the meta-field of the Resource

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:149
Sets the resource's modifierExtension-array to the provided array

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

the Builder

setPeriod

setPeriod(period?: Period): this

- Defined in src/care-plan-builder.ts:218
Sets the careplan's period field

Parameters
- Optional period: Period
  
  the period within which the careplan is active
Returns this

this CarePlanBuilder

setResourceType

setResourceType(resourceType?: code): this

Inherited from ResourceBuilder.setResourceType
- Defined in src/resource-builder.ts:45
Sets the resourceType-field of the Resource

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

setStatus

setStatus(status: CarePlanStatus): this

- Defined in src/care-plan-builder.ts:154
Sets the careplan's status field

Parameters
- status: CarePlanStatus
  
  the status to be set. Must be one of: draft | active | suspended | completed | entered-in-error | cancelled | unknown
Returns this
- The builder

setSubject

setSubject(subject?: Reference): this

- Defined in src/care-plan-builder.ts:200
Sets the careplan's subject field

Parameters
- Optional subject: Reference
  
  the subject which the careplan refereces
Returns this

this CarePlanBuilder

setText

setText(text?: Narrative): this

Inherited from DomainResourceBuilder.setText
- Defined in src/domain-resource-builder.ts:48
Sets the text-field of the DomainResource

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

setTitle

setTitle(title?: undefined | string): this

- Defined in src/care-plan-builder.ts:182
Sets the careplan's title field.

Parameters
- Optional title: undefined | string
  
  the title of the careplan
Returns this

this CarePlanBuilder

use

use(careplan?: CarePlan): this

Overrides DomainResourceBuilder.use
- Defined in src/care-plan-builder.ts:45
Sets an existing careplan for this CarePlanBuilder to allow for manipulating, or interacting with, the careplan through this CarePlanBuilder

Parameters
- Optional careplan: CarePlan
  
  The careplan to set
Returns this

This CarePlanBuilder

Generated using TypeDoc