Private ReadonlyrelatedFHIR CodeSystem: RelatedArtifactType
Privatetype_RelatedArtifact.type Element
FHIR Specification
codeCodeSystem Enumeration: RelatedArtifactTypeEnum
Private OptionallabelRelatedArtifact.label Element
Private OptionaldisplayRelatedArtifact.display Element
Private OptionalcitationRelatedArtifact.citation Element
FHIR Specification
markdownPrivate OptionalurlRelatedArtifact.url Element
FHIR Specification
urlPrivate OptionaldocumentRelatedArtifact.document Element
Private OptionalresourceRelatedArtifact.resource Element
FHIR Specification
canonical
StaticparseParse the provided RelatedArtifact JSON to instantiate the RelatedArtifact data model.
JSON representing FHIR RelatedArtifact
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to RelatedArtifact
RelatedArtifact data model or undefined for RelatedArtifact
JsonError if the provided JSON is not a valid JSON object
the type_ property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: RelatedArtifactTypeEnum
Assigns the provided EnumCodeType value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RelatedArtifactTypeEnum
true if the type_ property exists and has a value; false otherwise
the type_ property value as a CodeType if defined; else null
CodeSystem Enumeration: RelatedArtifactTypeEnum
Assigns the provided PrimitiveType value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RelatedArtifactTypeEnum
true if the type_ property exists and has a value; false otherwise
the type_ property value as a fhirCode if defined; else null
CodeSystem Enumeration: RelatedArtifactTypeEnum
Assigns the provided primitive value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: RelatedArtifactTypeEnum
true if the type_ property exists and has a value; false otherwise
the label property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the label property.
the label value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the label property exists and has a value; false otherwise
the label property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the label property.
the label value
this
PrimitiveTypeError for invalid primitive types
true if the label property exists and has a value; false otherwise
the display property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the display property.
the display value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the display property exists and has a value; false otherwise
the display property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the display property.
the display value
this
PrimitiveTypeError for invalid primitive types
true if the display property exists and has a value; false otherwise
the citation property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the citation property.
the citation value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the citation property exists and has a value; false otherwise
the citation property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the citation property.
the citation value
this
PrimitiveTypeError for invalid primitive types
true if the citation property exists and has a value; false otherwise
the url property value as a UrlType object if defined; else an empty UrlType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUrl if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the document property value as a Attachment object if defined; else an empty Attachment object
Assigns the provided Document object value to the document property.
the document object value
this
InvalidTypeError for invalid data types
true if the document property exists and has a value; false otherwise
the resource property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the resource property.
the resource value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the resource property exists and has a value; false otherwise
the resource property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the resource property.
the resource value
this
PrimitiveTypeError for invalid primitive types
true if the resource property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
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
Creates a copy of the current instance.
the a new instance copied from the current instance
true if the instance is a FHIR complex datatype; false otherwise
the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)
the JSON value or undefined if the instance is empty
true if the instance is a FHIR complex or primitive datatype; false otherwise
the id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
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.
AssertionError for invalid url
Determines if the extension property exists.
the url that identifies a specific Extension
an Extension having the provided url
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.
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
RelatedArtifact Class
Remarks
Base StructureDefinition for 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
See
FHIR RelatedArtifact