Class 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 Type implements org.hl7.fhir.instance.model.api.ICompositeType
Related artifacts such as additional documentation, justification, or bibliographic references.
See Also:
  • Field Details

    • type

      The type of relationship to the related artifact.
    • label

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

      protected StringType 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.
    • url

      protected UrlType url
      A url for the artifact that can be followed to access the actual content.
    • document

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

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

  • 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

      public boolean hasTypeElement()
    • hasType

      public boolean 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.
    • 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

      public boolean hasLabelElement()
    • hasLabel

      public boolean 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

      public String 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

      public boolean hasDisplayElement()
    • hasDisplay

      public boolean 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

      public String 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

      public boolean hasCitationElement()
    • hasCitation

      public boolean 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

      public String 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.
    • getUrlElement

      Returns:
      url (A url for the artifact that can be followed to access the actual content.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
    • hasUrlElement

      public boolean hasUrlElement()
    • hasUrl

      public boolean hasUrl()
    • setUrlElement

      Parameters:
      value - url (A url for the artifact that can be followed to access the actual content.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
    • getUrl

      public String getUrl()
      Returns:
      A url for the artifact that can be followed to access the actual content.
    • setUrl

      public RelatedArtifact setUrl(String value)
      Parameters:
      value - A url for the artifact that can be followed to access the actual content.
    • getDocument

      Returns:
      document (The document being referenced, represented as an attachment. This is exclusive with the resource element.)
    • hasDocument

      public boolean 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 resource, 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

      public boolean hasResourceElement()
    • hasResource

      public boolean hasResource()
    • setResourceElement

      Parameters:
      value - resource (The related resource, 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

      public String getResource()
      Returns:
      The related resource, such as a library, value set, profile, or other knowledge resource.
    • setResource

      Parameters:
      value - The related resource, such as a library, value set, profile, or other knowledge resource.
    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      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 class Element
      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 class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class Element
    • copy

      Overrides:
      copy in class Type
    • copyValues

      public void copyValues(RelatedArtifact dst)
    • typedCopy

      Specified by:
      typedCopy in class Type
    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element
    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Element