Class List
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.List
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class List extends DomainResource
A list is a curated collection of resources.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
List.Builder
static class
List.Entry
Entries in this list.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static List.Builder
builder()
boolean
equals(java.lang.Object obj)
CodeableConcept
getCode()
This code defines the purpose of the list - why it was created.DateTime
getDate()
The date that the list was prepared.CodeableConcept
getEmptyReason()
If the list is empty, why the list is empty.Reference
getEncounter()
The encounter that is the context in which this list was created.java.util.List<List.Entry>
getEntry()
Entries in this list.java.util.List<Identifier>
getIdentifier()
Identifier for the List assigned for business purposes outside the context of FHIR.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.java.util.List<Annotation>
getNote()
Comments that apply to the overall list.CodeableConcept
getOrderedBy()
What order applies to the items in the list.Reference
getSource()
The entity responsible for deciding what the contents of the list were.ListStatus
getStatus()
Indicates the current state of this list.Reference
getSubject()
The common subject (or patient) of the resources that are in the list if there is one.String
getTitle()
A label for the list assigned by the author.boolean
hasChildren()
int
hashCode()
List.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.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 java.util.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 java.util.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.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
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 interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public List.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static List.Builder builder()
-
-