Package org.linuxforhealth.fhir.model.resource

Class DocumentManifest

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class DocumentManifest
extends DomainResource
    A collection of documents compiled for a purpose together with metadata that applies to the collection.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getMasterIdentifier

        public Identifier getMasterIdentifier()
        A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
        Returns:
        An immutable object of type Identifier that may be null.

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        Other identifiers associated with the document manifest, including version independent identifiers.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getType

        public CodeableConcept getType()
        The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getSubject

        public Reference getSubject()
        Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
        Returns:
        An immutable object of type Reference that may be null.

      • getCreated

        public DateTime getCreated()
        When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
        Returns:
        An immutable object of type DateTime that may be null.

      • getAuthor

        public java.util.List<Reference> getAuthor()
        Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getRecipient

        public java.util.List<Reference> getRecipient()
        A patient, practitioner, or organization for which this set of documents is intended.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getSource

        public Uri getSource()
        Identifies the source system, application, or software that produced the document manifest.
        Returns:
        An immutable object of type Uri that may be null.

      • getDescription

        public String getDescription()
        Human-readable description of the source document. This is sometimes known as the "title".
        Returns:
        An immutable object of type String that may be null.

      • getContent

        public java.util.List<Reference> getContent()
        The list of Resources that consist of the parts of this manifest.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that is non-empty.

      • getRelated

        public java.util.List<DocumentManifest.Related> getRelated()
        Related identifiers or resources associated with the DocumentManifest.
        Returns:
        An unmodifiable list containing immutable objects of type DocumentManifest.Related 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