Class ExtensionBuilder

Class representing a FHIR

Hierarchy

ElementBuilder
- ExtensionBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new ExtensionBuilder(): ExtensionBuilder

Overrides ElementBuilder.constructor
- Defined in src/extension-builder.ts:53
Create a new FHIR ExtensionBuilder

Returns ExtensionBuilder

Methods

addExtension

addExtension(extension: Extension): this

Inherited from ElementBuilder.addExtension
- Defined in src/element-builder.ts:82
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

build(): Extension

Overrides ElementBuilder.build
- Defined in src/extension-builder.ts:956
Returns the extension

override

Returns Extension

The extension

conflictsWith

conflictsWith(element: Element): boolean

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

Parameters
- element: Element
  
  The element to test for conflict
Returns boolean

Whether it is in conflict

getExtension

getExtension(url?: url): Extension[]

Inherited from ElementBuilder.getExtension
- Defined in src/element-builder.ts:57
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

Inherited from ElementBuilder.getId
- Defined in src/element-builder.ts:38
Returns the element's id

Returns id | undefined

The element's id

getUrl

getUrl(): uri | undefined

- Defined in src/extension-builder.ts:78
Returns the url-field of the CarePlanActivity if it is set

Returns uri | undefined

The url-field

getValueAddress

getValueAddress(): Address | undefined

- Defined in src/extension-builder.ts:487
Returns the valueAddress-field of the Extension

Returns Address | undefined

The valueAddress-field

getValueAge

getValueAge(): Age | undefined

- Defined in src/extension-builder.ts:508
Returns the valueAge-field of the Extension

Returns Age | undefined

The valueAge-field

getValueAnnotation

getValueAnnotation(): Annotation | undefined

- Defined in src/extension-builder.ts:527
Returns the valueAnnotation-field of the Extension

Returns Annotation | undefined

The valueAnnotation-field

getValueAttachment

getValueAttachment(): Attachment | undefined

- Defined in src/extension-builder.ts:548
Returns the valueAttachment-field of the Extension

Returns Attachment | undefined

The valueAttachment-field

getValueBase64Binary

getValueBase64Binary(): base64Binary | undefined

- Defined in src/extension-builder.ts:96
Returns the valueBase64Binary-field of the Extension

Returns base64Binary | undefined

The valueBase64Binary-field

getValueBoolean

getValueBoolean(): boolean | undefined

- Defined in src/extension-builder.ts:117
Returns the valueBoolean-field of the Extension

Returns boolean | undefined

The valueBoolean-field

getValueCanonical

getValueCanonical(): canonical | undefined

- Defined in src/extension-builder.ts:138
Returns the valueCanonical-field of the Extension

Returns canonical | undefined

The valueCanonical-field

getValueCode

getValueCode(): code | undefined

- Defined in src/extension-builder.ts:159
Returns the valueCode-field of the Extension

Returns code | undefined

The valueCode-field

getValueCodeableConcept

getValueCodeableConcept(): CodeableConcept | undefined

- Defined in src/extension-builder.ts:569
Returns the valueCodeableConcept-field of the Extension

Returns CodeableConcept | undefined

The valueCodeableConcept-field

getValueCoding

getValueCoding(): Coding | undefined

- Defined in src/extension-builder.ts:590
Returns the valueCoding-field of the Extension

Returns Coding | undefined

The valueCoding-field

getValueContactPoint

getValueContactPoint(): ContactPoint | undefined

- Defined in src/extension-builder.ts:611
Returns the valueContactPoint-field of the Extension

Returns ContactPoint | undefined

The valueContactPoint-field

getValueCount

getValueCount(): Count | undefined

- Defined in src/extension-builder.ts:632
Returns the valueCount-field of the Extension

Returns Count | undefined

The valueCount-field

getValueDate

getValueDate(): date | undefined

- Defined in src/extension-builder.ts:180
Returns the valueDate-field of the Extension

Returns date | undefined

The valueDate-field

getValueDateTime

getValueDateTime(): dateTime | undefined

- Defined in src/extension-builder.ts:201
Returns the valueDateTime-field of the Extension

Returns dateTime | undefined

The valueDateTime-field

getValueDecimal

getValueDecimal(): decimal | undefined

- Defined in src/extension-builder.ts:222
Returns the valueDecimal-field of the Extension

Returns decimal | undefined

The valueDecimal-field

getValueDistance

getValueDistance(): Distance | undefined

- Defined in src/extension-builder.ts:653
Returns the valueDistance-field of the Extension

Returns Distance | undefined

The valueDistance-field

getValueDuration

getValueDuration(): Duration | undefined

- Defined in src/extension-builder.ts:674
Returns the valueDuration-field of the Extension

Returns Duration | undefined

The valueDuration-field

getValueHumanName

getValueHumanName(): HumanName | undefined

- Defined in src/extension-builder.ts:695
Returns the valueHumanName-field of the Extension

Returns HumanName | undefined

The valueHumanName-field

getValueId

getValueId(): id | undefined

- Defined in src/extension-builder.ts:243
Returns the valueId-field of the Extension

Returns id | undefined

The valueId-field

getValueIdentifier

getValueIdentifier(): Identifier | undefined

- Defined in src/extension-builder.ts:716
Returns the valueIdentifier-field of the Extension

Returns Identifier | undefined

The valueIdentifier-field

getValueInstant

getValueInstant(): instant | undefined

- Defined in src/extension-builder.ts:262
Returns the valueInstant-field of the Extension

Returns instant | undefined

The valueInstant-field

getValueInteger

getValueInteger(): integer | undefined

- Defined in src/extension-builder.ts:283
Returns the valueInteger-field of the Extension

Returns integer | undefined

The valueInteger-field

getValueMarkdown

getValueMarkdown(): markdown | undefined

- Defined in src/extension-builder.ts:304
Returns the valueMarkdown-field of the Extension

Returns markdown | undefined

The valueMarkdown-field

getValueMeta

getValueMeta(): Meta | undefined

- Defined in src/extension-builder.ts:925
Returns the valueMeta-field of the Extension

Returns Meta | undefined

The valueMeta-field

getValueMoney

getValueMoney(): Money | undefined

- Defined in src/extension-builder.ts:737
Returns the valueMoney-field of the Extension

Returns Money | undefined

The valueMoney-field

getValueOid

getValueOid(): oid | undefined

- Defined in src/extension-builder.ts:325
Returns the valueOid-field of the Extension

Returns oid | undefined

The valueOid-field

getValuePeriod

getValuePeriod(): Period | undefined

- Defined in src/extension-builder.ts:758
Returns the valuePeriod-field of the Extension

Returns Period | undefined

The valuePeriod-field

getValuePositiveInt

getValuePositiveInt(): positiveInt | undefined

- Defined in src/extension-builder.ts:344
Returns the valuePositiveInt-field of the Extension

Returns positiveInt | undefined

The valuePositiveInt-field

getValueQuantity

getValueQuantity(): Quantity | undefined

- Defined in src/extension-builder.ts:779
Returns the valueQuantity-field of the Extension

Returns Quantity | undefined

The valueQuantity-field

getValueRange

getValueRange(): Range | undefined

- Defined in src/extension-builder.ts:800
Returns the valueRange-field of the Extension

Returns Range | undefined

The valueRange-field

getValueRatio

getValueRatio(): Ratio | undefined

- Defined in src/extension-builder.ts:821
Returns the valueRatio-field of the Extension

Returns Ratio | undefined

The valueRatio-field

getValueReference

getValueReference(): Reference | undefined

- Defined in src/extension-builder.ts:842
Returns the valueReference-field of the CarePlanActivity if it is set

Returns Reference | undefined

The valueReference-field

getValueSampledData

getValueSampledData(): SampledData | undefined

- Defined in src/extension-builder.ts:862
Returns the valueSampledData-field of the Extension

Returns SampledData | undefined

The valueSampledData-field

getValueSignature

getValueSignature(): Signature | undefined

- Defined in src/extension-builder.ts:883
Returns the valueSignature-field of the Extension

Returns Signature | undefined

The valueSignature-field

getValueString

getValueString(): string | undefined

- Defined in src/extension-builder.ts:365
Returns the valueString-field of the Extension

Returns string | undefined

The valueString-field

getValueTime

getValueTime(): time | undefined

- Defined in src/extension-builder.ts:386
Returns the valueTime-field of the Extension

Returns time | undefined

The valueTime-field

getValueTiming

getValueTiming(): Timing | undefined

- Defined in src/extension-builder.ts:904
Returns the valueTiming-field of the Extension

Returns Timing | undefined

The valueTiming-field

getValueUnsignedInt

getValueUnsignedInt(): unsignedInt | undefined

- Defined in src/extension-builder.ts:407
Returns the valueUnsignedInt-field of the Extension

Returns unsignedInt | undefined

The valueUnsignedInt-field

getValueUri

getValueUri(): uri | undefined

- Defined in src/extension-builder.ts:428
Returns the valueUri-field of the Extension

Returns uri | undefined

The valueUri-field

getValueUrl

getValueUrl(): url | undefined

- Defined in src/extension-builder.ts:447
Returns the valueUrl-field of the Extension

Returns url | undefined

The valueUrl-field

getValueUuid

getValueUuid(): uuid | undefined

- Defined in src/extension-builder.ts:466
Returns the valueUuid-field of the Extension

Returns uuid | undefined

The valueUuid-field

Protected make

make(): Extension

Overrides ElementBuilder.make
- Defined in src/extension-builder.ts:947
Make a new object that implements a FHIR Extension

override

Returns Extension
- an object that implements FHIR Extension

setExtension

setExtension(extension?: Extension[]): this

Inherited from ElementBuilder.setExtension
- Defined in src/element-builder.ts:70
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

Inherited from ElementBuilder.setId
- Defined in src/element-builder.ts:48
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

setUrl

setUrl(url?: uri): this

- Defined in src/extension-builder.ts:87
Sets the url-field of the CarePlanActivity with the provided uri If no argument is provided, the field will be removed

Parameters
- Optional url: uri
Returns this

The builder

setValueAddress

setValueAddress(valueAddress?: Address): this

- Defined in src/extension-builder.ts:497
Sets the valueAddress-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueAddress: Address
  
  The value to be set in the valueAddress-field
Returns this
- The builder

setValueAge

setValueAge(valueAge?: Age): this

- Defined in src/extension-builder.ts:518
Sets the valueAge-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueAge: Age
  
  The value to be set in the valueAge-field
Returns this
- The builder

setValueAnnotation

setValueAnnotation(valueAnnotation?: Annotation): this

- Defined in src/extension-builder.ts:537
Sets the valueAnnotation-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueAnnotation: Annotation
  
  The value to be set in the valueAnnotation-field
Returns this
- The builder

setValueAttachment

setValueAttachment(valueAttachment?: Attachment): this

- Defined in src/extension-builder.ts:558
Sets the valueAttachment-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueAttachment: Attachment
  
  The value to be set in the valueAttachment-field
Returns this
- The builder

setValueBase64Binary

setValueBase64Binary(valueBase64Binary?: base64Binary): this

- Defined in src/extension-builder.ts:106
Sets the valueBase64Binary-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueBase64Binary: base64Binary
  
  The value to be set in the valueBase64Binary-field
Returns this
- The builder

setValueBoolean

setValueBoolean(valueBoolean?: undefined | false | true): this

- Defined in src/extension-builder.ts:127
Sets the valueBoolean-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueBoolean: undefined | false | true
  
  The value to be set in the valueBoolean-field
Returns this
- The builder

setValueCanonical

setValueCanonical(valueCanonical?: canonical): this

- Defined in src/extension-builder.ts:148
Sets the valueCanonical-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueCanonical: canonical
  
  The value to be set in the valueCanonical-field
Returns this
- The builder

setValueCode

setValueCode(valueCode?: code): this

- Defined in src/extension-builder.ts:169
Sets the valueCode-field of the Extension If no argument is provided, the field will be removed

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

setValueCodeableConcept

setValueCodeableConcept(valueCodeableConcept?: CodeableConcept): this

- Defined in src/extension-builder.ts:579
Sets the valueCodeableConcept-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueCodeableConcept: CodeableConcept
  
  The value to be set in the valueCodeableConcept-field
Returns this
- The builder

setValueCoding

setValueCoding(valueCoding?: Coding): this

- Defined in src/extension-builder.ts:600
Sets the valueCoding-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueCoding: Coding
  
  The value to be set in the valueCoding-field
Returns this
- The builder

setValueContactPoint

setValueContactPoint(valueContactPoint?: ContactPoint): this

- Defined in src/extension-builder.ts:621
Sets the valueContactPoint-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueContactPoint: ContactPoint
  
  The value to be set in the valueContactPoint-field
Returns this
- The builder

setValueCount

setValueCount(valueCount?: Count): this

- Defined in src/extension-builder.ts:642
Sets the valueCount-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueCount: Count
  
  The value to be set in the valueCount-field
Returns this
- The builder

setValueDate

setValueDate(valueDate?: date): this

- Defined in src/extension-builder.ts:190
Sets the valueDate-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueDate: date
  
  The value to be set in the valueDate-field
Returns this
- The builder

setValueDateTime

setValueDateTime(valueDateTime?: dateTime): this

- Defined in src/extension-builder.ts:211
Sets the valueDateTime-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueDateTime: dateTime
  
  The value to be set in the valueDateTime-field
Returns this
- The builder

setValueDecimal

setValueDecimal(valueDecimal?: decimal): this

- Defined in src/extension-builder.ts:232
Sets the valueDecimal-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueDecimal: decimal
  
  The value to be set in the valueDecimal-field
Returns this
- The builder

setValueDistance

setValueDistance(valueDistance?: Distance): this

- Defined in src/extension-builder.ts:663
Sets the valueDistance-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueDistance: Distance
  
  The value to be set in the valueDistance-field
Returns this
- The builder

setValueDuration

setValueDuration(valueDuration?: Duration): this

- Defined in src/extension-builder.ts:684
Sets the valueDuration-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueDuration: Duration
  
  The value to be set in the valueDuration-field
Returns this
- The builder

setValueHumanName

setValueHumanName(valueHumanName?: HumanName): this

- Defined in src/extension-builder.ts:705
Sets the valueHumanName-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueHumanName: HumanName
  
  The value to be set in the valueHumanName-field
Returns this
- The builder

setValueId

setValueId(valueId?: id): this

- Defined in src/extension-builder.ts:253
Sets the valueId-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueId: id
  
  The value to be set in the valueId-field
Returns this
- The builder

setValueIdentifier

setValueIdentifier(valueIdentifier?: Identifier): this

- Defined in src/extension-builder.ts:726
Sets the valueIdentifier-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueIdentifier: Identifier
  
  The value to be set in the valueIdentifier-field
Returns this
- The builder

setValueInstant

setValueInstant(valueInstant?: instant): this

- Defined in src/extension-builder.ts:272
Sets the valueInstant-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueInstant: instant
  
  The value to be set in the valueInstant-field
Returns this
- The builder

setValueInteger

setValueInteger(valueInteger?: integer): this

- Defined in src/extension-builder.ts:293
Sets the valueInteger-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueInteger: integer
  
  The value to be set in the valueInteger-field
Returns this
- The builder

setValueMarkdown

setValueMarkdown(valueMarkdown?: markdown): this

- Defined in src/extension-builder.ts:314
Sets the valueMarkdown-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueMarkdown: markdown
  
  The value to be set in the valueMarkdown-field
Returns this
- The builder

setValueMeta

setValueMeta(valueMeta?: Meta): this

- Defined in src/extension-builder.ts:935
Sets the valueMeta-field of the Extension If no argument is provided, the field will be removed

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

setValueMoney

setValueMoney(valueMoney?: Money): this

- Defined in src/extension-builder.ts:747
Sets the valueMoney-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueMoney: Money
  
  The value to be set in the valueMoney-field
Returns this
- The builder

setValueOid

setValueOid(valueOid?: oid): this

- Defined in src/extension-builder.ts:335
Sets the valueOid-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueOid: oid
  
  The value to be set in the valueOid-field
Returns this
- The builder

setValuePeriod

setValuePeriod(valuePeriod?: Period): this

- Defined in src/extension-builder.ts:768
Sets the valuePeriod-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valuePeriod: Period
  
  The value to be set in the valuePeriod-field
Returns this
- The builder

setValuePositiveInt

setValuePositiveInt(valuePositiveInt?: positiveInt): this

- Defined in src/extension-builder.ts:354
Sets the valuePositiveInt-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valuePositiveInt: positiveInt
  
  The value to be set in the valuePositiveInt-field
Returns this
- The builder

setValueQuantity

setValueQuantity(valueQuantity?: Quantity): this

- Defined in src/extension-builder.ts:789
Sets the valueQuantity-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueQuantity: Quantity
  
  The value to be set in the valueQuantity-field
Returns this
- The builder

setValueRange

setValueRange(valueRange?: Range): this

- Defined in src/extension-builder.ts:810
Sets the valueRange-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueRange: Range
  
  The value to be set in the valueRange-field
Returns this
- The builder

setValueRatio

setValueRatio(valueRatio?: Ratio): this

- Defined in src/extension-builder.ts:831
Sets the valueRatio-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueRatio: Ratio
  
  The value to be set in the valueRatio-field
Returns this
- The builder

setValueReference

setValueReference(valueReference?: Reference): this

- Defined in src/extension-builder.ts:851
Sets the valueReference-field of the CarePlanActivity with the provided reference If no argument is provided, the field will be removed

Parameters
- Optional valueReference: Reference
Returns this

The builder

setValueSampledData

setValueSampledData(valueSampledData?: SampledData): this

- Defined in src/extension-builder.ts:872
Sets the valueSampledData-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueSampledData: SampledData
  
  The value to be set in the valueSampledData-field
Returns this
- The builder

setValueSignature

setValueSignature(valueSignature?: Signature): this

- Defined in src/extension-builder.ts:893
Sets the valueSignature-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueSignature: Signature
  
  The value to be set in the valueSignature-field
Returns this
- The builder

setValueString

setValueString(valueString?: undefined | string): this

- Defined in src/extension-builder.ts:375
Sets the valueString-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueString: undefined | string
  
  The value to be set in the valueString-field
Returns this
- The builder

setValueTime

setValueTime(valueTime?: time): this

- Defined in src/extension-builder.ts:396
Sets the valueTime-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueTime: time
  
  The value to be set in the valueTime-field
Returns this
- The builder

setValueTiming

setValueTiming(valueTiming?: Timing): this

- Defined in src/extension-builder.ts:914
Sets the valueTiming-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueTiming: Timing
  
  The value to be set in the valueTiming-field
Returns this
- The builder

setValueUnsignedInt

setValueUnsignedInt(valueUnsignedInt?: unsignedInt): this

- Defined in src/extension-builder.ts:417
Sets the valueUnsignedInt-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueUnsignedInt: unsignedInt
  
  The value to be set in the valueUnsignedInt-field
Returns this
- The builder

setValueUri

setValueUri(valueUri?: uri): this

- Defined in src/extension-builder.ts:438
Sets the valueUri-field of the Extension If no argument is provided, the field will be removed

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

setValueUrl

setValueUrl(valueUrl?: url): this

- Defined in src/extension-builder.ts:457
Sets the valueUrl-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueUrl: url
  
  The value to be set in the valueUrl-field
Returns this
- The builder

setValueUuid

setValueUuid(valueUuid?: uuid): this

- Defined in src/extension-builder.ts:476
Sets the valueUuid-field of the Extension If no argument is provided, the field will be removed

Parameters
- Optional valueUuid: uuid
  
  The value to be set in the valueUuid-field
Returns this
- The builder

use

use(extension?: Extension): this

Overrides ElementBuilder.use
- Defined in src/extension-builder.ts:69
Sets a copy of an already existing extension as the element to build If no argument is provided, a new Extension will be generated

override

Parameters
- Optional extension: Extension
Returns this

The builder

Generated using TypeDoc