Package com.ibm.fhir.model.resource

Class List

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class List
extends DomainResource
    A list is a curated collection of resources.

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Identifier for the List assigned for business purposes outside the context of FHIR.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getStatus

        public ListStatus getStatus()
        Indicates the current state of this list.
        Returns:
        An immutable object of type ListStatus that is non-null.

      • getMode

        public ListMode getMode()
        How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
        Returns:
        An immutable object of type ListMode that is non-null.

      • getTitle

        public String getTitle()
        A label for the list assigned by the author.
        Returns:
        An immutable object of type String that may be null.

      • getCode

        public CodeableConcept getCode()
        This code defines the purpose of the list - why it was created.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getSubject

        public Reference getSubject()
        The common subject (or patient) of the resources that are in the list if there is one.
        Returns:
        An immutable object of type Reference that may be null.

      • getEncounter

        public Reference getEncounter()
        The encounter that is the context in which this list was created.
        Returns:
        An immutable object of type Reference that may be null.

      • getDate

        public DateTime getDate()
        The date that the list was prepared.
        Returns:
        An immutable object of type DateTime that may be null.

      • getSource

        public Reference getSource()
        The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
        Returns:
        An immutable object of type Reference that may be null.

      • getOrderedBy

        public CodeableConcept getOrderedBy()
        What order applies to the items in the list.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getNote

        public List<Annotation> getNote()
        Comments that apply to the overall list.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getEntry

        public List<List.Entry> getEntry()
        Entries in this list.
        Returns:
        An unmodifiable list containing immutable objects of type List.Entry that may be empty.

      • getEmptyReason

        public CodeableConcept getEmptyReason()
        If the list is empty, why the list is empty.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • accept

        public void accept​(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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object