Skip to main content

HS.FHIRModel.R4.RelatedArtifact

class HS.FHIRModel.R4.RelatedArtifact extends HS.FHIRModel.FHIRClassSuper

*****************************************
** RelatedArtifact generated class schema
*****************************************
Related artifacts such as additional documentation, justification, or bibliographic references.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_RELATEDARTIFACT;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _citation as HS.FHIRModel.R4.Element;
Extensions for citation
Property methods: _citationGet(), _citationGetSwizzled(), _citationIsValid(), _citationNewObject(), _citationSet()
property _display as HS.FHIRModel.R4.Element;
Extensions for display
Property methods: _displayGet(), _displayGetSwizzled(), _displayIsValid(), _displayNewObject(), _displaySet()
property _label as HS.FHIRModel.R4.Element;
Extensions for label
Property methods: _labelGet(), _labelGetSwizzled(), _labelIsValid(), _labelNewObject(), _labelSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property citation as %String;
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Property methods: citationDisplayToLogical(), citationGet(), citationIsValid(), citationLogicalToDisplay(), citationLogicalToOdbc(), citationNormalize(), citationSet()
property display as %String;
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Property methods: displayDisplayToLogical(), displayGet(), displayIsValid(), displayLogicalToDisplay(), displayLogicalToOdbc(), displayNormalize(), displaySet()
property document as HS.FHIRModel.R4.Attachment;
The document being referenced, represented as an attachment. This is exclusive with the resource element.
Property methods: documentGet(), documentGetSwizzled(), documentIsValid(), documentNewObject(), documentSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property label as %String;
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Property methods: labelDisplayToLogical(), labelGet(), labelIsValid(), labelLogicalToDisplay(), labelLogicalToOdbc(), labelNormalize(), labelSet()
property resource as %String;
The related resource, such as a library, value set, profile, or other knowledge resource.
Property methods: resourceDisplayToLogical(), resourceGet(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceSet()
property type as %String (VALUELIST = ",documentation,justification,citation,predecessor,successor,derived-from,depends-on,composed-of");
The type of relationship to the related artifact.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property url as %String;
A url for the artifact that can be followed to access the actual content.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()

Methods

method IncludeDocument()
method IncludeExtension()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab