Class TerminologyCapabilitiesCodeSystemComponent

TerminologyCapabilitiesCodeSystemComponent Class

Remarks

FHIR Specification

Short: A code system supported by the server
Definition: Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.
Comment: The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.

See

FHIR TerminologyCapabilities

Hierarchy (View Summary)

BackboneElement
- TerminologyCapabilitiesCodeSystemComponent

Implements

IBackboneElement

Index

Constructors

constructor

Properties

uri? version? codesystemContentModeEnum content subsumption?

Constructors

constructor

new TerminologyCapabilitiesCodeSystemComponent(
content?: null | string | CodeType | EnumCodeType,
): TerminologyCapabilitiesCodeSystemComponent
Parameters
- content: null | string | CodeType | EnumCodeType = null
Returns TerminologyCapabilitiesCodeSystemComponent
Overrides BackboneElement.constructor
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3473

Properties

`Private` `Optional`uri

uri?: CanonicalType

TerminologyCapabilities.codeSystem.uri Element

Remarks

FHIR Specification

Short: Canonical identifier for the code system, represented as a URI
Definition: Canonical identifier for the code system, represented as a URI.
FHIR Type: canonical
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/CodeSystem', ]
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`version

version?: TerminologyCapabilitiesCodeSystemVersionComponent[]

TerminologyCapabilities.codeSystem.version Element

Remarks

FHIR Specification

Short: Version of Code System supported
Definition: For the code system, a list of versions that are supported by the server.
Comment: Language translations might not be available for all codes.
FHIR Type: BackboneElement
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Readonly`codesystemContentModeEnum

codesystemContentModeEnum: CodesystemContentModeEnum

FHIR CodeSystem: CodesystemContentMode

See

CodesystemContentModeEnum

`Private`content

content: null | EnumCodeType

TerminologyCapabilities.codeSystem.content Element

Remarks

FHIR Specification

Short: not-present | example | fragment | complete | supplement
Definition: The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: true

See

CodeSystem Enumeration: CodesystemContentModeEnum

`Private` `Optional`subsumption

subsumption?: BooleanType

TerminologyCapabilities.codeSystem.subsumption Element

Remarks

FHIR Specification

Short: Whether subsumption is supported
Definition: True if subsumption is supported for this version of the code system.
FHIR Type: boolean
Cardinality: 0..1
isModifier: false
isSummary: false

Methods

`Static`parse

parse(
sourceJson: Value,
optSourceField?: string,
): undefined | TerminologyCapabilitiesCodeSystemComponent
Parse the provided TerminologyCapabilitiesCodeSystemComponent JSON to instantiate the TerminologyCapabilitiesCodeSystemComponent data model.
Parameters
- sourceJson: Value
  JSON representing FHIR TerminologyCapabilitiesCodeSystemComponent
- OptionaloptSourceField: string
  Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to TerminologyCapabilitiesCodeSystemComponent
Returns undefined | TerminologyCapabilitiesCodeSystemComponent
TerminologyCapabilitiesCodeSystemComponent data model or undefined for TerminologyCapabilitiesCodeSystemComponent

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3494

getUriElement

getUriElement(): CanonicalType
Returns CanonicalType
the uri property value as a CanonicalType object if defined; else an empty CanonicalType object
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3635

setUriElement

setUriElement(element: undefined | CanonicalType): this
Assigns the provided PrimitiveType value to the uri property.
Parameters
- element: undefined | CanonicalType
  the uri value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3647

hasUriElement

hasUriElement(): boolean
Returns boolean
true if the uri property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3661

getUri

getUri(): undefined | string
Returns undefined | string
the uri property value as a fhirCanonical if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3668

setUri

setUri(value: undefined | string): this
Assigns the provided primitive value to the uri property.
Parameters
- value: undefined | string
  the uri value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3679

hasUri

hasUri(): boolean
Returns boolean
true if the uri property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3692

getVersion

getVersion(): TerminologyCapabilitiesCodeSystemVersionComponent[]
Returns TerminologyCapabilitiesCodeSystemVersionComponent[]
the version property value as a TerminologyCapabilitiesCodeSystemVersionComponent array
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3699

setVersion

setVersion(
value: undefined | TerminologyCapabilitiesCodeSystemVersionComponent[],
): this
Assigns the provided TerminologyCapabilitiesCodeSystemVersionComponent array value to the version property.
Parameters
- value: undefined | TerminologyCapabilitiesCodeSystemVersionComponent[]
  the version array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3710

addVersion

addVersion(
value: undefined | TerminologyCapabilitiesCodeSystemVersionComponent,
): this
Add the provided TerminologyCapabilitiesCodeSystemVersionComponent value to the version array property.
Parameters
- value: undefined | TerminologyCapabilitiesCodeSystemVersionComponent
  the version value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3728

hasVersion

hasVersion(): boolean
Returns boolean
true if the version property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3741

getContentEnumType

getContentEnumType(): null | EnumCodeType
Returns null | EnumCodeType
the content property value as a EnumCodeType if defined; else null

See
CodeSystem Enumeration: CodesystemContentModeEnum
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3759

setContentEnumType

setContentEnumType(enumType: undefined | null | EnumCodeType): this
Assigns the provided EnumCodeType value to the content property.
Parameters
- enumType: undefined | null | EnumCodeType
  the content value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: CodesystemContentModeEnum
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3773

hasContentEnumType

hasContentEnumType(): boolean
Returns boolean
true if the content property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3787

getContentElement

getContentElement(): null | CodeType
Returns null | CodeType
the content property value as a CodeType if defined; else null

See
CodeSystem Enumeration: CodesystemContentModeEnum
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3796

setContentElement

setContentElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the content property.
Parameters
- element: undefined | null | CodeType
  the content value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: CodesystemContentModeEnum
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3813

hasContentElement

hasContentElement(): boolean
Returns boolean
true if the content property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3827

getContent

getContent(): null | string
Returns null | string
the content property value as a fhirCode if defined; else null

See
CodeSystem Enumeration: CodesystemContentModeEnum
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3836

setContent

setContent(value: undefined | null | string): this
Assigns the provided primitive value to the content property.
Parameters
- value: undefined | null | string
  the content value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: CodesystemContentModeEnum
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3853

hasContent

hasContent(): boolean
Returns boolean
true if the content property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3866

getSubsumptionElement

getSubsumptionElement(): BooleanType
Returns BooleanType
the subsumption property value as a BooleanType object if defined; else an empty BooleanType object
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3873

setSubsumptionElement

setSubsumptionElement(element: undefined | BooleanType): this
Assigns the provided PrimitiveType value to the subsumption property.
Parameters
- element: undefined | BooleanType
  the subsumption value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3885

hasSubsumptionElement

hasSubsumptionElement(): boolean
Returns boolean
true if the subsumption property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3899

getSubsumption

getSubsumption(): undefined | boolean
Returns undefined | boolean
the subsumption property value as a fhirBoolean if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3906

setSubsumption

setSubsumption(value: undefined | boolean): this
Assigns the provided primitive value to the subsumption property.
Parameters
- value: undefined | boolean
  the subsumption value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3917

hasSubsumption

hasSubsumption(): boolean
Returns boolean
true if the subsumption property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3930

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IBackboneElement.fhirType
Overrides BackboneElement.fhirType
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3939

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IBackboneElement.isEmpty
Overrides BackboneElement.isEmpty
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3946

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
Returns boolean
true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise
Implementation of IBackboneElement.isRequiredFieldsEmpty
Overrides BackboneElement.isRequiredFieldsEmpty
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3959

copy

copy(): TerminologyCapabilitiesCodeSystemComponent
Creates a copy of the current instance.

Returns TerminologyCapabilitiesCodeSystemComponent
the a new instance copied from the current instance
Implementation of IBackboneElement.copy
Overrides BackboneElement.copy
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3970

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IBackboneElement.toJSON
Overrides BackboneElement.toJSON
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3994

getModifierExtension

getModifierExtension(): IExtension[]
Returns IExtension[]
the array of modifierExtension values
Implementation of IBackboneElement.getModifierExtension
Inherited from BackboneElement.getModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:195

setModifierExtension

setModifierExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the modifierExtension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setModifierExtension
Inherited from BackboneElement.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:202

hasModifierExtension

hasModifierExtension(url?: string): boolean
Determines if the modifierExtension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url; false otherwise

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasModifierExtension
Inherited from BackboneElement.hasModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:214

getModifierExtensionByUrl

getModifierExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getModifierExtensionByUrl
Inherited from BackboneElement.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:222

addModifierExtension

addModifierExtension(extension: undefined | IExtension): this
Adds the provided Extension to the modifierExtension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the modifierExtension property array
Returns this
this
Implementation of IBackboneElement.addModifierExtension
Inherited from BackboneElement.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:229

removeModifierExtension

removeModifierExtension(url: string): void
Removes the Extension having the provided url from the modifierExtension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeModifierExtension
Inherited from BackboneElement.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:236

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IBackboneElement.getId
Inherited from BackboneElement.getId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:59

setId

setId(value: undefined | string): this
Assigns the provided value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid value
Implementation of IBackboneElement.setId
Inherited from BackboneElement.setId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:67

hasId

hasId(): boolean
Returns boolean
true if id exists and has a value; false otherwise
Implementation of IBackboneElement.hasId
Inherited from BackboneElement.hasId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:71

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IBackboneElement.getExtension
Inherited from BackboneElement.getExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:75

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setExtension
Inherited from BackboneElement.setExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:82

hasExtension

hasExtension(url?: string): boolean
Determines if the extension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url; false otherwise

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasExtension
Inherited from BackboneElement.hasExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:94

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
Determines if the extension property exists.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
an Extension having the provided url

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getExtensionByUrl
Inherited from BackboneElement.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:106

addExtension

addExtension(extension: undefined | IExtension): this
Adds the provided Extension to the extension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the extension property array
Returns this
this
Implementation of IBackboneElement.addExtension
Inherited from BackboneElement.addExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:113

removeExtension

removeExtension(url: string): void
Removes the Extension having the provided url from the extension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeExtension
Inherited from BackboneElement.removeExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:120

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IBackboneElement.isResource
Inherited from BackboneElement.isResource
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:67

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IBackboneElement.isDataType
Inherited from BackboneElement.isDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:71

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IBackboneElement.isComplexDataType
Inherited from BackboneElement.isComplexDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:75

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IBackboneElement.isPrimitive
Inherited from BackboneElement.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IBackboneElement.isBooleanPrimitive
Inherited from BackboneElement.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IBackboneElement.isStringPrimitive
Inherited from BackboneElement.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IBackboneElement.isNumberPrimitive
Inherited from BackboneElement.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IBackboneElement.isBigIntPrimitive
Inherited from BackboneElement.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IBackboneElement.isDateTimePrimitive
Inherited from BackboneElement.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: TerminologyCapabilitiesCodeSystemComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: TerminologyCapabilitiesCodeSystemComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3982

`Private`initVersion

initVersion(): void
Initialize the version property

Returns void
- Defined in packages/r5-datamodels/src/resources/TerminologyCapabilities.ts:3748

Class TerminologyCapabilitiesCodeSystemComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TerminologyCapabilitiesCodeSystemComponent

Properties

Private Optionaluri

Remarks

Private Optionalversion

Remarks

Private ReadonlycodesystemContentModeEnum

See

Privatecontent

Remarks

See

Private Optionalsubsumption

Remarks

Methods

Staticparse

Parameters

Returns undefined | TerminologyCapabilitiesCodeSystemComponent

Throws

getUriElement

Returns CanonicalType

setUriElement

Parameters

Returns this

Throws

Throws

hasUriElement

Returns boolean

getUri

Returns undefined | string

setUri

Parameters

Returns this

Throws

hasUri

Returns boolean

getVersion

Returns TerminologyCapabilitiesCodeSystemVersionComponent[]

setVersion

Parameters

Returns this

Throws

addVersion

Parameters

Returns this

Throws

hasVersion

Returns boolean

getContentEnumType

Returns null | EnumCodeType

See

setContentEnumType

Parameters

Returns this

Throws

Throws

See

hasContentEnumType

Returns boolean

getContentElement

Returns null | CodeType

See

setContentElement

Parameters

Returns this

Throws

Throws

See

hasContentElement

`Private` `Optional`uri

`Private` `Optional`version

`Private` `Readonly`codesystemContentModeEnum

`Private`content

`Private` `Optional`subsumption

`Static`parse