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:
    Serialized Form
    • Field Detail

      • display

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

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

        protected UriType 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

        protected Reference resource
        The related resource, such as a library, value set, profile, or other knowledge resource.
      • resourceTarget

        protected Resource resourceTarget
        The actual object that is the target of the reference (The related resource, such as a library, value set, profile, or other knowledge resource.)
    • Method Detail

      • hasType

        public boolean hasType()
      • getDisplayElement

        public StringType 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
      • setDisplayElement

        public RelatedArtifact setDisplayElement​(StringType value)
        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

        public RelatedArtifact setDisplay​(String value)
        Parameters:
        value - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
      • getCitationElement

        public StringType 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
      • setCitationElement

        public RelatedArtifact setCitationElement​(StringType value)
        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

        public RelatedArtifact setCitation​(String value)
        Parameters:
        value - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
      • getUrlElement

        public UriType 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
      • hasUrl

        public boolean hasUrl()
      • setUrlElement

        public RelatedArtifact setUrlElement​(UriType value)
        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

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

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

        public Resource getResourceTarget()
        Returns:
        resource The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The related resource, such as a library, value set, profile, or other knowledge resource.)
      • setResourceTarget

        public RelatedArtifact setResourceTarget​(Resource value)
        Parameters:
        value - resource The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The related resource, such as a library, value set, profile, or other knowledge resource.)
      • 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
      • 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
      • isEmpty

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