Package org.hl7.fhir.r5.model
Class RelatedArtifact
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.DataType
org.hl7.fhir.r5.model.RelatedArtifact
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseDatatype
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.ICompositeType
public class RelatedArtifact
extends DataType
implements org.hl7.fhir.instance.model.api.ICompositeType
RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionprotected MarkdownType
A bibliographic citation for the related artifact.protected List
<CodeableConcept> Provides additional classifiers of the related artifact.protected StringType
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.protected Attachment
The document being referenced, represented as an attachment.protected StringType
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.protected DateType
The date of publication of the artifact being referred to.protected Enumeration
<Enumerations.PublicationStatus> The publication status of the artifact being referred to.protected CanonicalType
The related artifact, such as a library, value set, profile, or other knowledge resource.protected Reference
The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.protected Enumeration
<RelatedArtifact.RelatedArtifactType> The type of relationship to the related artifact. -
Constructor Summary
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getLabel()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasLabel()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCitation
(String value) setCitationElement
(MarkdownType value) setClassifier
(List<CodeableConcept> theClassifier) setDisplay
(String value) setDisplayElement
(StringType value) setDocument
(Attachment value) setLabelElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublicationDate
(Date value) setResource
(String value) setResourceElement
(CanonicalType value) setResourceReference
(Reference value) protected RelatedArtifact
Methods inherited from class org.hl7.fhir.r5.model.DataType
copyValues, getTranslation, isTranslatable
Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
-
Field Details
-
type
The type of relationship to the related artifact. -
classifier
Provides additional classifiers of the related artifact. -
label
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. -
display
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. -
citation
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. -
document
The document being referenced, represented as an attachment. This is exclusive with the resource element. -
resource
The related artifact, such as a library, value set, profile, or other knowledge resource. -
resourceReference
The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. -
publicationStatus
The publication status of the artifact being referred to. -
publicationDate
The date of publication of the artifact being referred to.
-
-
Constructor Details
-
RelatedArtifact
public RelatedArtifact()Constructor -
RelatedArtifact
Constructor
-
-
Method Details
-
getTypeElement
- Returns:
type
(The type of relationship to the related artifact.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
hasTypeElement
-
hasType
-
setTypeElement
- Parameters:
value
-type
(The type of relationship to the related artifact.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
getType
- Returns:
- The type of relationship to the related artifact.
-
setType
- Parameters:
value
- The type of relationship to the related artifact.
-
getClassifier
- Returns:
classifier
(Provides additional classifiers of the related artifact.)
-
setClassifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClassifier
-
addClassifier
-
addClassifier
-
getClassifierFirstRep
- Returns:
- The first repetition of repeating field
classifier
, creating it if it does not already exist {3}
-
getLabelElement
- Returns:
label
(A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value
-
hasLabelElement
-
hasLabel
-
setLabelElement
- Parameters:
value
-label
(A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value
-
getLabel
- Returns:
- A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
-
setLabel
- Parameters:
value
- A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
-
getDisplayElement
- Returns:
display
(A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
-
hasDisplayElement
-
hasDisplay
-
setDisplayElement
- Parameters:
value
-display
(A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
-
getDisplay
- Returns:
- A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
-
setDisplay
- Parameters:
value
- A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
-
getCitationElement
- Returns:
citation
(A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.). This is the underlying object with id, value and extensions. The accessor "getCitation" gives direct access to the value
-
hasCitationElement
-
hasCitation
-
setCitationElement
- Parameters:
value
-citation
(A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.). This is the underlying object with id, value and extensions. The accessor "getCitation" gives direct access to the value
-
getCitation
- Returns:
- A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
-
setCitation
- Parameters:
value
- A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
-
getDocument
- Returns:
document
(The document being referenced, represented as an attachment. This is exclusive with the resource element.)
-
hasDocument
-
setDocument
- Parameters:
value
-document
(The document being referenced, represented as an attachment. This is exclusive with the resource element.)
-
getResourceElement
- Returns:
resource
(The related artifact, such as a library, value set, profile, or other knowledge resource.). This is the underlying object with id, value and extensions. The accessor "getResource" gives direct access to the value
-
hasResourceElement
-
hasResource
-
setResourceElement
- Parameters:
value
-resource
(The related artifact, such as a library, value set, profile, or other knowledge resource.). This is the underlying object with id, value and extensions. The accessor "getResource" gives direct access to the value
-
getResource
- Returns:
- The related artifact, such as a library, value set, profile, or other knowledge resource.
-
setResource
- Parameters:
value
- The related artifact, such as a library, value set, profile, or other knowledge resource.
-
getResourceReference
- Returns:
resourceReference
(The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.)
-
hasResourceReference
-
setResourceReference
- Parameters:
value
-resourceReference
(The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.)
-
getPublicationStatusElement
- Returns:
publicationStatus
(The publication status of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationStatus" gives direct access to the value
-
hasPublicationStatusElement
-
hasPublicationStatus
-
setPublicationStatusElement
public RelatedArtifact setPublicationStatusElement(Enumeration<Enumerations.PublicationStatus> value) - Parameters:
value
-publicationStatus
(The publication status of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationStatus" gives direct access to the value
-
getPublicationStatus
- Returns:
- The publication status of the artifact being referred to.
-
setPublicationStatus
- Parameters:
value
- The publication status of the artifact being referred to.
-
getPublicationDateElement
- Returns:
publicationDate
(The date of publication of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationDate" gives direct access to the value
-
hasPublicationDateElement
-
hasPublicationDate
-
setPublicationDateElement
- Parameters:
value
-publicationDate
(The date of publication of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationDate" gives direct access to the value
-
getPublicationDate
- Returns:
- The date of publication of the artifact being referred to.
-
setPublicationDate
- Parameters:
value
- The date of publication of the artifact being referred to.
-
listChildren
- Overrides:
listChildren
in classElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
-
fhirType
-
copy
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classElement
-
equalsShallow
- Overrides:
equalsShallow
in classElement
-
isEmpty
-