Class DomainResourceBuilder

Class representing a FHIR DomainResource builder

Hierarchy

ResourceBuilder
- DomainResourceBuilder

Index

Constructors

constructor

Constructors

constructor

new DomainResourceBuilder(): DomainResourceBuilder

Overrides ResourceBuilder.constructor
- Defined in src/domain-resource-builder.ts:15
Creates a new FHIR DomainResourceBuilder

Returns DomainResourceBuilder

Methods

addContained

addContained(contained: Resource): this

- 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

- 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

addModifierExtension

addModifierExtension(modifierExtension: Extension): this

- 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(): DomainResource

Overrides ResourceBuilder.build
- Defined in src/domain-resource-builder.ts:196
Builds and returns the domainResource

override

Returns DomainResource
- the domainResource

conflictsWith

conflictsWith(resource: Resource): boolean

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

getContained

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

- 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
- Defined in src/domain-resource-builder.ts:61
Parameters
- id: id
Returns Resource | undefined

getExtension

getExtension(url?: uri): Extension[]

- 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

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

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

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[]

- 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

getText

getText(): Narrative | undefined

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

Returns Narrative | undefined

The text-field

Protected make

make(): DomainResource

Overrides ResourceBuilder.make
- Defined in src/domain-resource-builder.ts:184
Make a new object that implements a FHIR DomainResource

override

Returns DomainResource
- an object that implements FHIR DomainResource

setContained

setContained(contained?: Resource[]): this

- 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

- 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

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

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

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

- 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

setText

setText(text?: Narrative): this

- 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(domainResource?: DomainResource): this

Overrides ResourceBuilder.use
- Defined in src/domain-resource-builder.ts:32
Sets a copy of an existing domainResource for this builder to allow for manipulation, If no argument is provided, a new DomainResource will be generated

override

Parameters
- Optional domainResource: DomainResource
  
  the domainResource to be set
Returns this

The builder

Generated using TypeDoc