Package com.ibm.fhir.model.type

Class RelatedArtifact

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.RelatedArtifact

All Implemented Interfaces:

Visitable

@Generated("com.ibm.fhir.tools.CodeGenerator")
public class RelatedArtifact
extends Element

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelatedArtifact.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.Element

extension, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static RelatedArtifact.Builder	builder()
boolean	equals(Object obj)
Markdown	getCitation()	A bibliographic citation for the related artifact.
String	getDisplay()	A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Attachment	getDocument()	The document being referenced, represented as an attachment.
String	getLabel()	A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Canonical	getResource()	The related resource, such as a library, value set, profile, or other knowledge resource.
RelatedArtifactType	getType()	The type of relationship to the related artifact.
Url	getUrl()	A url for the artifact that can be followed to access the actual content.
boolean	hasChildren()
int	hashCode()
RelatedArtifact.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getType

public RelatedArtifactType getType()

The type of relationship to the related artifact.

Returns:

An immutable object of type RelatedArtifactType that is non-null.

getLabel

public String getLabel()

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Returns:

An immutable object of type String that may be null.

getDisplay

public String getDisplay()

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Returns:

An immutable object of type String that may be null.

getCitation

public Markdown getCitation()

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Returns:

An immutable object of type Markdown that may be null.

getUrl

public Url getUrl()

A url for the artifact that can be followed to access the actual content.

Returns:

An immutable object of type Url that may be null.

getDocument

public Attachment getDocument()

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Returns:

An immutable object of type Attachment that may be null.

getResource

public Canonical getResource()

The related resource, such as a library, value set, profile, or other knowledge resource.

Returns:

An immutable object of type Canonical that may be null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class Element

accept

public void accept(String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public RelatedArtifact.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class Element

builder

public static RelatedArtifact.Builder builder()