Class RelatedArtifact

RelatedArtifact Class

Remarks

RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.

Knowledge resources must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

FHIR Specification

Short: Related artifacts for a knowledge resource
Definition: Related artifacts such as additional documentation, justification, or bibliographic references.
Comment: Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.
FHIR Version: 5.0.0

See

FHIR RelatedArtifact

Hierarchy (View Summary)

DataType
- RelatedArtifact

Implements

IDataType

Index

Constructors

constructor

Properties

Methods

parse getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getClassifier setClassifier addClassifier hasClassifier getLabelElement setLabelElement hasLabelElement getLabel setLabel hasLabel getDisplayElement setDisplayElement hasDisplayElement getDisplay setDisplay hasDisplay getCitationElement setCitationElement hasCitationElement getCitation setCitation hasCitation getDocument setDocument hasDocument getResourceElement setResourceElement hasResourceElement getResource setResource hasResource getResourceReference setResourceReference hasResourceReference getPublicationStatusEnumType setPublicationStatusEnumType hasPublicationStatusEnumType getPublicationStatusElement setPublicationStatusElement hasPublicationStatusElement getPublicationStatus setPublicationStatus hasPublicationStatus getPublicationDateElement setPublicationDateElement hasPublicationDateElement getPublicationDate setPublicationDate hasPublicationDate fhirType isEmpty isRequiredFieldsEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initClassifier

Constructors

constructor

new RelatedArtifact(
type_?: null | string | CodeType | EnumCodeType,
): RelatedArtifact
Parameters
- type_: null | string | CodeType | EnumCodeType = null
Returns RelatedArtifact
Overrides DataType.constructor
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:34628

Properties

`Private` `Readonly`relatedArtifactTypeEnum

relatedArtifactTypeEnum: RelatedArtifactTypeEnum

FHIR CodeSystem: RelatedArtifactType

See

RelatedArtifactTypeEnum

`Private`type_

type_: null | EnumCodeType

RelatedArtifact.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
Definition: The type of relationship to the related artifact.
Comment: The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: true

See

CodeSystem Enumeration: RelatedArtifactTypeEnum

`Private` `Optional`classifier

classifier?: CodeableConcept[]

RelatedArtifact.classifier Element

Remarks

FHIR Specification

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

`Private` `Optional`label

label?: StringType

RelatedArtifact.label Element

Remarks

FHIR Specification

Short: Short label
Definition: A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`display

display?: StringType

RelatedArtifact.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: true

`Private` `Optional`citation

citation?: MarkdownType

RelatedArtifact.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.
Comment: Additional structured information about citations should be captured as extensions.
FHIR Type: markdown
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`document

document?: Attachment

RelatedArtifact.document Element

Remarks

FHIR Specification

Short: What document is being referenced
Definition: The document being referenced, represented as an attachment. This is exclusive with the resource element.
FHIR Type: Attachment
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`resource

resource?: CanonicalType

RelatedArtifact.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
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Resource', ]
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`resourceReference

resourceReference?: Reference

RelatedArtifact.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
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Resource', ]
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Readonly`publicationStatusEnum

publicationStatusEnum: PublicationStatusEnum

FHIR CodeSystem: PublicationStatus

See

PublicationStatusEnum

`Private` `Optional`publicationStatus

publicationStatus?: EnumCodeType

RelatedArtifact.publicationStatus Element

Remarks

FHIR Specification

Short: draft | active | retired | unknown
Definition: The publication status of the artifact being referred to.
FHIR Type: code
Cardinality: 0..1
isModifier: false
isSummary: true

See

CodeSystem Enumeration: PublicationStatusEnum

`Private` `Optional`publicationDate

publicationDate?: DateType

RelatedArtifact.publicationDate Element

Remarks

FHIR Specification

Short: Date of publication of the artifact being referred to
Definition: The date of publication of the artifact being referred to.
FHIR Type: date
Cardinality: 0..1
isModifier: false
isSummary: true

Methods

`Static`parse

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

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:34650

getTypeEnumType

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

See
CodeSystem Enumeration: RelatedArtifactTypeEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:34944

setTypeEnumType

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

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: RelatedArtifactTypeEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:34958

hasTypeEnumType

hasTypeEnumType(): boolean
Returns boolean
true if the type_ property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:34972

getTypeElement

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

See
CodeSystem Enumeration: RelatedArtifactTypeEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:34981

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
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: RelatedArtifactTypeEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:34998

hasTypeElement

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

getType

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

See
CodeSystem Enumeration: RelatedArtifactTypeEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35021

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
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: RelatedArtifactTypeEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35038

hasType

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

getClassifier

getClassifier(): CodeableConcept[]
Returns CodeableConcept[]
the classifier property value as a CodeableConcept array
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35058

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/complex-types/complex-datatypes.ts:35069

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/complex-types/complex-datatypes.ts:35087

hasClassifier

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

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/complex-types/complex-datatypes.ts:35116

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/complex-types/complex-datatypes.ts:35128

hasLabelElement

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

getLabel

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

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/complex-types/complex-datatypes.ts:35160

hasLabel

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

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/complex-types/complex-datatypes.ts:35180

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/complex-types/complex-datatypes.ts:35192

hasDisplayElement

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

getDisplay

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

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/complex-types/complex-datatypes.ts:35224

hasDisplay

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

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/complex-types/complex-datatypes.ts:35244

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/complex-types/complex-datatypes.ts:35256

hasCitationElement

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

getCitation

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

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/complex-types/complex-datatypes.ts:35288

hasCitation

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

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/complex-types/complex-datatypes.ts:35308

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/complex-types/complex-datatypes.ts:35319

hasDocument

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

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/complex-types/complex-datatypes.ts:35340

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/complex-types/complex-datatypes.ts:35352

hasResourceElement

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

getResource

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

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/complex-types/complex-datatypes.ts:35384

hasResource

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

getResourceReference

getResourceReference(): Reference
Returns Reference
the resourceReference property value as a Reference object; else an empty Reference object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35404

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('RelatedArtifact.resourceReference', ['Resource',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35420

hasResourceReference

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

getPublicationStatusEnumType

getPublicationStatusEnumType(): undefined | EnumCodeType
Returns undefined | EnumCodeType
the publicationStatus property value as a EnumCodeType if defined; else undefined

See
CodeSystem Enumeration: PublicationStatusEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35442

setPublicationStatusEnumType

setPublicationStatusEnumType(enumType: undefined | EnumCodeType): this
Assigns the provided EnumCodeType value to the publicationStatus property.
Parameters
- enumType: undefined | EnumCodeType
  the publicationStatus value
Returns this
this

Throws
InvalidCodeError for invalid code values

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: PublicationStatusEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35456

hasPublicationStatusEnumType

hasPublicationStatusEnumType(): boolean
Returns boolean
true if the publicationStatus property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35470

getPublicationStatusElement

getPublicationStatusElement(): undefined | CodeType
Returns undefined | CodeType
the publicationStatus property value as a CodeType if defined; else undefined

See
CodeSystem Enumeration: PublicationStatusEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35479

setPublicationStatusElement

setPublicationStatusElement(element: undefined | CodeType): this
Assigns the provided PrimitiveType value to the publicationStatus property.
Parameters
- element: undefined | CodeType
  the publicationStatus value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: PublicationStatusEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35496

hasPublicationStatusElement

hasPublicationStatusElement(): boolean
Returns boolean
true if the publicationStatus property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35510

getPublicationStatus

getPublicationStatus(): undefined | string
Returns undefined | string
the publicationStatus property value as a fhirCode if defined; else undefined

See
CodeSystem Enumeration: PublicationStatusEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35519

setPublicationStatus

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

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: PublicationStatusEnum
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35536

hasPublicationStatus

hasPublicationStatus(): boolean
Returns boolean
true if the publicationStatus property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35549

getPublicationDateElement

getPublicationDateElement(): DateType
Returns DateType
the publicationDate property value as a DateType object if defined; else an empty DateType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35556

setPublicationDateElement

setPublicationDateElement(element: undefined | DateType): this
Assigns the provided PrimitiveType value to the publicationDate property.
Parameters
- element: undefined | DateType
  the publicationDate value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35568

hasPublicationDateElement

hasPublicationDateElement(): boolean
Returns boolean
true if the publicationDate property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35582

getPublicationDate

getPublicationDate(): undefined | string
Returns undefined | string
the publicationDate property value as a fhirDate if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35589

setPublicationDate

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

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35600

hasPublicationDate

hasPublicationDate(): boolean
Returns boolean
true if the publicationDate property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35613

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IDataType.fhirType
Overrides DataType.fhirType
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35622

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IDataType.isEmpty
Overrides DataType.isEmpty
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35629

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 IDataType.isRequiredFieldsEmpty
Overrides DataType.isRequiredFieldsEmpty
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35648

copy

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

Returns RelatedArtifact
the a new instance copied from the current instance
Implementation of IDataType.copy
Overrides DataType.copy
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35659

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IDataType.isComplexDataType
Overrides DataType.isComplexDataType
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35689

dataTypeName

dataTypeName(): string
Returns string
the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)
Implementation of IDataType.dataTypeName
Overrides DataType.dataTypeName
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35696

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IDataType.toJSON
Overrides DataType.toJSON
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35703

isDataType

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

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IDataType.getId
Inherited from DataType.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 IDataType.setId
Inherited from DataType.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 IDataType.hasId
Inherited from DataType.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 IDataType.getExtension
Inherited from DataType.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 IDataType.setExtension
Inherited from DataType.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 IDataType.hasExtension
Inherited from DataType.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 IDataType.getExtensionByUrl
Inherited from DataType.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 IDataType.addExtension
Inherited from DataType.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 IDataType.removeExtension
Inherited from DataType.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 IDataType.isResource
Inherited from DataType.isResource
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:67

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IDataType.isPrimitive
Inherited from DataType.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 IDataType.isBooleanPrimitive
Inherited from DataType.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 IDataType.isStringPrimitive
Inherited from DataType.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 IDataType.isNumberPrimitive
Inherited from DataType.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 IDataType.isBigIntPrimitive
Inherited from DataType.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 IDataType.isDateTimePrimitive
Inherited from DataType.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: RelatedArtifact): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: RelatedArtifact
  the copied instance
Returns void
Overrides DataType.copyValues
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35671

`Private`initClassifier

initClassifier(): void
Initialize the classifier property

Returns void
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35107

Class RelatedArtifact

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RelatedArtifact

Properties

Private ReadonlyrelatedArtifactTypeEnum

See

Privatetype_

Remarks

See

Private Optionalclassifier

Remarks

Private Optionallabel

Remarks

Private Optionaldisplay

Remarks

Private Optionalcitation

Remarks

Private Optionaldocument

Remarks

Private Optionalresource

Remarks

Private OptionalresourceReference

Remarks

Private ReadonlypublicationStatusEnum

See

Private OptionalpublicationStatus

Remarks

See

Private OptionalpublicationDate

Remarks

Methods

Staticparse

Parameters

Returns undefined | RelatedArtifact

Throws

getTypeEnumType

Returns null | EnumCodeType

See

setTypeEnumType

Parameters

Returns this

Throws

Throws

See

hasTypeEnumType

Returns boolean

getTypeElement

Returns null | CodeType

See

setTypeElement

Parameters

Returns this

Throws

Throws

See

hasTypeElement

Returns boolean

getType

Returns null | string

See

setType

Parameters

Returns this

Throws

Throws

See

hasType

Returns boolean

getClassifier

Returns CodeableConcept[]

`Private` `Readonly`relatedArtifactTypeEnum

`Private`type_

`Private` `Optional`classifier

`Private` `Optional`label

`Private` `Optional`display

`Private` `Optional`citation

`Private` `Optional`document

`Private` `Optional`resource

`Private` `Optional`resourceReference

`Private` `Readonly`publicationStatusEnum

`Private` `Optional`publicationStatus

`Private` `Optional`publicationDate

`Static`parse