Class CitationCitedArtifactRelatesToComponent

CitationCitedArtifactRelatesToComponent Class

Remarks

FHIR Specification

Short: The artifact related to the cited artifact
Definition: The artifact related to the cited artifact.
Comment: The citedArtifact.relatesTo element uses a BackboneElement instead of the RelatedArtifact Datatype to enable use of an extended value set for the required code for the type of relationship.

See

FHIR Citation

Hierarchy (View Summary)

BackboneElement
- CitationCitedArtifactRelatesToComponent

Implements

IBackboneElement

Index

Constructors

constructor

new CitationCitedArtifactRelatesToComponent(
type_?: null | string | CodeType,
): CitationCitedArtifactRelatesToComponent
Parameters
- type_: null | string | CodeType = null
Returns CitationCitedArtifactRelatesToComponent
Overrides BackboneElement.constructor
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7255

Properties

`Private`type_

type_: null | CodeType

Citation.citedArtifact.relatesTo.type Element

Remarks

FHIR Specification

Short: documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
Definition: The type of relationship to the related artifact.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: false

`Private` `Optional`classifier

classifier?: CodeableConcept[]

Citation.citedArtifact.relatesTo.classifier Element

Remarks

FHIR Specification

Short: Additional classifiers
Definition: Provides additional classifiers of the related artifact.
FHIR Type: CodeableConcept
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Optional`label

label?: StringType

Citation.citedArtifact.relatesTo.label Element

Remarks

FHIR Specification

Short: Short label
Definition: A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.
Comment: Though not commonly used in citation records, this could be used for referencing other articles in the abstract or explanatory notes.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`display

display?: StringType

Citation.citedArtifact.relatesTo.display Element

Remarks

FHIR Specification

Short: Brief description of the related artifact
Definition: A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`citation

citation?: MarkdownType

Citation.citedArtifact.relatesTo.citation Element

Remarks

FHIR Specification

Short: Bibliographic citation for the artifact
Definition: A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
FHIR Type: markdown
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`document

document?: Attachment

Citation.citedArtifact.relatesTo.document Element

Remarks

FHIR Specification

Short: What document is being referenced
Definition: The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.
Comment: To refer to related artifacts by URL, the FHIR Attachment Datatype includes a url element, so the path would be Citation.citedArtifact.relatesTo.document.url
FHIR Type: Attachment
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`resource

resource?: CanonicalType

Citation.citedArtifact.relatesTo.resource Element

Remarks

FHIR Specification

Short: What artifact is being referenced
Definition: The related artifact, such as a library, value set, profile, or other knowledge resource.
Comment: If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource
FHIR Type: canonical
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`resourceReference

resourceReference?: Reference

Citation.citedArtifact.relatesTo.resourceReference Element

Remarks

FHIR Specification

Short: What artifact, if not a conformance resource
Definition: The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Comment: If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
FHIR Type: Reference
Cardinality: 0..1
isModifier: false
isSummary: false

Methods

`Static`parse

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

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

getTypeElement

getTypeElement(): CodeType
Returns CodeType
the type_ property value as a CodeType object if defined; else an empty CodeType object
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7498

setTypeElement

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

Throws
InvalidTypeError for invalid data types

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

hasTypeElement

hasTypeElement(): boolean
Returns boolean
true if the type_ property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7524

getType

getType(): null | string
Returns null | string
the type_ property value as a fhirCode if defined; else null
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7531

setType

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

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

hasType

hasType(): boolean
Returns boolean
true if the type_ property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7559

getClassifier

getClassifier(): CodeableConcept[]
Returns CodeableConcept[]
the classifier property value as a CodeableConcept array
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7566

setClassifier

setClassifier(value: undefined | CodeableConcept[]): this
Assigns the provided CodeableConcept array value to the classifier property.
Parameters
- value: undefined | CodeableConcept[]
  the classifier array value
Returns this
this

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

addClassifier

addClassifier(value: undefined | CodeableConcept): this
Add the provided CodeableConcept value to the classifier array property.
Parameters
- value: undefined | CodeableConcept
  the classifier value
Returns this
this

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

hasClassifier

hasClassifier(): boolean
Returns boolean
true if the classifier property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7608

getLabelElement

getLabelElement(): StringType
Returns StringType
the label property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7624

setLabelElement

setLabelElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the label property.
Parameters
- element: undefined | StringType
  the label value
Returns this
this

Throws
InvalidTypeError for invalid data types

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

hasLabelElement

hasLabelElement(): boolean
Returns boolean
true if the label property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7650

getLabel

getLabel(): undefined | string
Returns undefined | string
the label property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7657

setLabel

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

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

hasLabel

hasLabel(): boolean
Returns boolean
true if the label property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7681

getDisplayElement

getDisplayElement(): StringType
Returns StringType
the display property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7688

setDisplayElement

setDisplayElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the display property.
Parameters
- element: undefined | StringType
  the display value
Returns this
this

Throws
InvalidTypeError for invalid data types

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

hasDisplayElement

hasDisplayElement(): boolean
Returns boolean
true if the display property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7714

getDisplay

getDisplay(): undefined | string
Returns undefined | string
the display property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7721

setDisplay

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

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

hasDisplay

hasDisplay(): boolean
Returns boolean
true if the display property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7745

getCitationElement

getCitationElement(): MarkdownType
Returns MarkdownType
the citation property value as a MarkdownType object if defined; else an empty MarkdownType object
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7752

setCitationElement

setCitationElement(element: undefined | MarkdownType): this
Assigns the provided PrimitiveType value to the citation property.
Parameters
- element: undefined | MarkdownType
  the citation value
Returns this
this

Throws
InvalidTypeError for invalid data types

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

hasCitationElement

hasCitationElement(): boolean
Returns boolean
true if the citation property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7778

getCitation

getCitation(): undefined | string
Returns undefined | string
the citation property value as a fhirMarkdown if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7785

setCitation

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

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

hasCitation

hasCitation(): boolean
Returns boolean
true if the citation property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7809

getDocument

getDocument(): Attachment
Returns Attachment
the document property value as a Attachment object if defined; else an empty Attachment object
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7816

setDocument

setDocument(value: undefined | Attachment): this
Assigns the provided Document object value to the document property.
Parameters
- value: undefined | Attachment
  the document object value
Returns this
this

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

hasDocument

hasDocument(): boolean
Returns boolean
true if the document property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7841

getResourceElement

getResourceElement(): CanonicalType
Returns CanonicalType
the resource property value as a CanonicalType object if defined; else an empty CanonicalType object
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7848

setResourceElement

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

Throws
InvalidTypeError for invalid data types

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

hasResourceElement

hasResourceElement(): boolean
Returns boolean
true if the resource property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7874

getResource

getResource(): undefined | string
Returns undefined | string
the resource property value as a fhirCanonical if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7881

setResource

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

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

hasResource

hasResource(): boolean
Returns boolean
true if the resource property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7905

getResourceReference

getResourceReference(): Reference
Returns Reference
the resourceReference property value as a Reference object; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7912

setResourceReference

setResourceReference(value: undefined | Reference): this
Assigns the provided ResourceReference object value to the resourceReference property.
Parameters
- value: undefined | Reference
  the resourceReference object value
Returns this
this

Decorator
@ReferenceTargets('Citation.citedArtifact.relatesTo.resourceReference', [])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7926

hasResourceReference

hasResourceReference(): boolean
Returns boolean
true if the resourceReference property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7939

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/Citation.ts:7948

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/Citation.ts:7955

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/Citation.ts:7972

copy

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

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

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/Citation.ts:8011

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: CitationCitedArtifactRelatesToComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: CitationCitedArtifactRelatesToComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7995

`Private`initClassifier

initClassifier(): void
Initialize the classifier property

Returns void
- Defined in packages/r5-datamodels/src/resources/Citation.ts:7615

Class CitationCitedArtifactRelatesToComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CitationCitedArtifactRelatesToComponent

Properties

Privatetype_

Remarks

Private Optionalclassifier

Remarks

Private Optionallabel

Remarks

Private Optionaldisplay

Remarks

Private Optionalcitation

Remarks

Private Optionaldocument

Remarks

Private Optionalresource

Remarks

Private OptionalresourceReference

Remarks

Methods

Staticparse

Parameters

Returns undefined | CitationCitedArtifactRelatesToComponent

Throws

getTypeElement

Returns CodeType

setTypeElement

Parameters

Returns this

Throws

Throws

hasTypeElement

Returns boolean

getType

Returns null | string

setType

Parameters

Returns this

Throws

hasType

Returns boolean

getClassifier

Returns CodeableConcept[]

setClassifier

Parameters

Returns this

Throws

addClassifier

Parameters

Returns this

Throws

hasClassifier

Returns boolean

getLabelElement

Returns StringType

setLabelElement

Parameters

Returns this

Throws

Throws

hasLabelElement

Returns boolean

getLabel

Returns undefined | string

setLabel

Parameters

Returns this

Throws

hasLabel

`Private`type_

`Private` `Optional`classifier

`Private` `Optional`label

`Private` `Optional`display

`Private` `Optional`citation

`Private` `Optional`document

`Private` `Optional`resource

`Private` `Optional`resourceReference

`Static`parse