Package org.linuxforhealth.fhir.model.resource

Class Citation

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class Citation
extends DomainResource
    The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.

    Maturity level: FMM0 (Trial Use)

    • Method Detail

      • getUrl

        public Uri getUrl()
        An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
        Returns:
        An immutable object of type Uri that may be null.

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getVersion

        public String getVersion()
        The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
        Returns:
        An immutable object of type String that may be null.

      • getName

        public String getName()
        A natural language name identifying the citation. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Returns:
        An immutable object of type String that may be null.

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the citation.
        Returns:
        An immutable object of type String that may be null.

      • getStatus

        public PublicationStatus getStatus()
        The status of this summary. Enables tracking the life-cycle of the content.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the citation.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public java.util.List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the citation from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public java.util.List<UsageContext> getUseContext()
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public java.util.List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the citation is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explanation of why this citation is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCopyright

        public Markdown getCopyright()
        Use and/or publishing restrictions for the Citation, not for the cited artifact.
        Returns:
        An immutable object of type Markdown that may be null.

      • getApprovalDate

        public Date getApprovalDate()
        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        Returns:
        An immutable object of type Date that may be null.

      • getLastReviewDate

        public Date getLastReviewDate()
        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        Returns:
        An immutable object of type Date that may be null.

      • getEffectivePeriod

        public Period getEffectivePeriod()
        The period during which the citation content was or is planned to be in active use.
        Returns:
        An immutable object of type Period that may be null.

      • getAuthor

        public java.util.List<ContactDetail> getAuthor()
        Who authored the Citation.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getEditor

        public java.util.List<ContactDetail> getEditor()
        Who edited the Citation.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getReviewer

        public java.util.List<ContactDetail> getReviewer()
        Who reviewed the Citation.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getEndorser

        public java.util.List<ContactDetail> getEndorser()
        Who endorsed the Citation.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getSummary

        public java.util.List<Citation.Summary> getSummary()
        A human-readable display of the citation.
        Returns:
        An unmodifiable list containing immutable objects of type Citation.Summary that may be empty.

      • getClassification

        public java.util.List<Citation.Classification> getClassification()
        The assignment to an organizing scheme.
        Returns:
        An unmodifiable list containing immutable objects of type Citation.Classification that may be empty.

      • getNote

        public java.util.List<Annotation> getNote()
        Used for general notes and annotations not coded elsewhere.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getCurrentState

        public java.util.List<CodeableConcept> getCurrentState()
        The status of the citation.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getStatusDate

        public java.util.List<Citation.StatusDate> getStatusDate()
        An effective date or period for a status of the citation.
        Returns:
        An unmodifiable list containing immutable objects of type Citation.StatusDate that may be empty.

      • getRelatesTo

        public java.util.List<Citation.RelatesTo> getRelatesTo()
        Artifact related to the Citation Resource.
        Returns:
        An unmodifiable list containing immutable objects of type Citation.RelatesTo that may be empty.

      • accept

        public void accept​(java.lang.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​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object