ListResource (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.model.ListResource

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class ListResource
extends DomainResource
```
A list is a curated collection of resources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListResource.ListEntryComponent`
`static class`	`ListResource.ListMode`
`static class`	`ListResource.ListModeEnumFactory`
`static class`	`ListResource.ListStatus`
`static class`	`ListResource.ListStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected CodeableConcept`	`code` This code defines the purpose of the list - why it was created.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`protected DateTimeType`	`date` The date that the list was prepared.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`EMPTY_REASON` Fluent Client search parameter constant for empty-reason
`protected CodeableConcept`	`emptyReason` If the list is empty, why the list is empty.
`protected Reference`	`encounter` The encounter that is the context in which this list was created.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENCOUNTER` Fluent Client search parameter constant for encounter
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (The encounter that is the context in which this list was created.)
`protected List<ListResource.ListEntryComponent>`	`entry` Entries in this list.
`protected List<Identifier>`	`identifier` Identifier for the List assigned for business purposes outside the context of FHIR.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENCOUNTER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ITEM` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SOURCE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ITEM` Fluent Client search parameter constant for item
`protected Enumeration<ListResource.ListMode>`	`mode` 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.
`protected List<Annotation>`	`note` Comments that apply to the overall list.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`NOTES` Fluent Client search parameter constant for notes
`protected CodeableConcept`	`orderedBy` What order applies to the items in the list.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected Reference`	`source` The entity responsible for deciding what the contents of the list were.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SOURCE` Fluent Client search parameter constant for source
`protected Resource`	`sourceTarget` The actual object that is the target of the reference (The entity responsible for deciding what the contents of the list were.
`static String`	`SP_CODE` Search parameter: code
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_EMPTY_REASON` Search parameter: empty-reason
`static String`	`SP_ENCOUNTER` Search parameter: encounter
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_ITEM` Search parameter: item
`static String`	`SP_NOTES` Search parameter: notes
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_SOURCE` Search parameter: source
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_SUBJECT` Search parameter: subject
`static String`	`SP_TITLE` Search parameter: title
`protected Enumeration<ListResource.ListStatus>`	`status` Indicates the current state of this list.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected Reference`	`subject` The common subject (or patient) of the resources that are in the list if there is one.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (The common subject (or patient) of the resources that are in the list if there is one.)
`protected StringType`	`title` A label for the list assigned by the author.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`TITLE` Fluent Client search parameter constant for title

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`ListResource()` Constructor
`ListResource(Enumeration<ListResource.ListStatus> status, Enumeration<ListResource.ListMode> mode)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ListResource.ListEntryComponent`	`addEntry()`
`ListResource`	`addEntry(ListResource.ListEntryComponent t)`
`Identifier`	`addIdentifier()`
`ListResource`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`ListResource`	`addNote(Annotation t)`
`ListResource`	`copy()`
`void`	`copyValues(ListResource dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`CodeableConcept`	`getCode()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`CodeableConcept`	`getEmptyReason()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<ListResource.ListEntryComponent>`	`getEntry()`
`ListResource.ListEntryComponent`	`getEntryFirstRep()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`ListResource.ListMode`	`getMode()`
`Enumeration<ListResource.ListMode>`	`getModeElement()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`CodeableConcept`	`getOrderedBy()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`Reference`	`getSource()`
`Resource`	`getSourceTarget()`
`ListResource.ListStatus`	`getStatus()`
`Enumeration<ListResource.ListStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`String`	`getTitle()`
`StringType`	`getTitleElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasCode()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasEmptyReason()`
`boolean`	`hasEncounter()`
`boolean`	`hasEntry()`
`boolean`	`hasIdentifier()`
`boolean`	`hasMode()`
`boolean`	`hasModeElement()`
`boolean`	`hasNote()`
`boolean`	`hasOrderedBy()`
`boolean`	`hasSource()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasTitle()`
`boolean`	`hasTitleElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`ListResource`	`setCode(CodeableConcept value)`
`ListResource`	`setDate(Date value)`
`ListResource`	`setDateElement(DateTimeType value)`
`ListResource`	`setEmptyReason(CodeableConcept value)`
`ListResource`	`setEncounter(Reference value)`
`ListResource`	`setEncounterTarget(Encounter value)`
`ListResource`	`setEntry(List<ListResource.ListEntryComponent> theEntry)`
`ListResource`	`setIdentifier(List<Identifier> theIdentifier)`
`ListResource`	`setMode(ListResource.ListMode value)`
`ListResource`	`setModeElement(Enumeration<ListResource.ListMode> value)`
`ListResource`	`setNote(List<Annotation> theNote)`
`ListResource`	`setOrderedBy(CodeableConcept value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`ListResource`	`setSource(Reference value)`
`ListResource`	`setSourceTarget(Resource value)`
`ListResource`	`setStatus(ListResource.ListStatus value)`
`ListResource`	`setStatusElement(Enumeration<ListResource.ListStatus> value)`
`ListResource`	`setSubject(Reference value)`
`ListResource`	`setSubjectTarget(Resource value)`
`ListResource`	`setTitle(String value)`
`ListResource`	`setTitleElement(StringType value)`
`protected ListResource`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Identifier for the List assigned for business purposes outside the context of FHIR.
  - status
```
protected Enumeration<ListResource.ListStatus> status
```
    Indicates the current state of this list.
  - mode
```
protected Enumeration<ListResource.ListMode> mode
```
    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.
  - title
```
protected StringType title
```
    A label for the list assigned by the author.
  - code
```
protected CodeableConcept code
```
    This code defines the purpose of the list - why it was created.
  - subject
```
protected Reference subject
```
    The common subject (or patient) of the resources that are in the list if there is one.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (The common subject (or patient) of the resources that are in the list if there is one.)
  - encounter
```
protected Reference encounter
```
    The encounter that is the context in which this list was created.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (The encounter that is the context in which this list was created.)
  - date
```
protected DateTimeType date
```
    The date that the list was prepared.
  - source
```
protected Reference source
```
    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.
  - sourceTarget
```
protected Resource sourceTarget
```
    The actual object that is the target of the reference (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.)
  - orderedBy
```
protected CodeableConcept orderedBy
```
    What order applies to the items in the list.
  - note
```
protected List<Annotation> note
```
    Comments that apply to the overall list.
  - entry
```
protected List<ListResource.ListEntryComponent> entry
```
    Entries in this list.
  - emptyReason
```
protected CodeableConcept emptyReason
```
    If the list is empty, why the list is empty.
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: When the list was prepared
    Type: date
    Path: List.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: When the list was prepared
    Type: date
    Path: List.date
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Business identifier
    Type: token
    Path: List.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Business identifier
    Type: token
    Path: List.identifier
  - SP_ITEM
```
public static final String SP_ITEM
```
    Search parameter: item
    Description: Actual entry
    Type: reference
    Path: List.entry.item
    
    See Also:
    
    Constant Field Values
  - ITEM
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ITEM
```
    Fluent Client search parameter constant for item
    Description: Actual entry
    Type: reference
    Path: List.entry.item
  - INCLUDE_ITEM
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ITEM
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ListResource:item".
  - SP_EMPTY_REASON
```
public static final String SP_EMPTY_REASON
```
    Search parameter: empty-reason
    Description: Why list is empty
    Type: token
    Path: List.emptyReason
    
    See Also:
    
    Constant Field Values
  - EMPTY_REASON
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMPTY_REASON
```
    Fluent Client search parameter constant for empty-reason
    Description: Why list is empty
    Type: token
    Path: List.emptyReason
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter: code
    Description: What the purpose of this list is
    Type: token
    Path: List.code
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description: What the purpose of this list is
    Type: token
    Path: List.code
  - SP_NOTES
```
public static final String SP_NOTES
```
    Search parameter: notes
    Description: The annotation - text content (as markdown)
    Type: string
    Path: List.note.text
    
    See Also:
    
    Constant Field Values
  - NOTES
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam NOTES
```
    Fluent Client search parameter constant for notes
    Description: The annotation - text content (as markdown)
    Type: string
    Path: List.note.text
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: If all resources have the same subject
    Type: reference
    Path: List.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: If all resources have the same subject
    Type: reference
    Path: List.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ListResource:subject".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: If all resources have the same subject
    Type: reference
    Path: List.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: If all resources have the same subject
    Type: reference
    Path: List.subject
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ListResource:patient".
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter: source
    Description: Who and/or what defined the list contents (aka Author)
    Type: reference
    Path: List.source
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description: Who and/or what defined the list contents (aka Author)
    Type: reference
    Path: List.source
  - INCLUDE_SOURCE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ListResource:source".
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter: encounter
    Description: Context in which list created
    Type: reference
    Path: List.encounter
    
    See Also:
    
    Constant Field Values
  - ENCOUNTER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
```
    Fluent Client search parameter constant for encounter
    Description: Context in which list created
    Type: reference
    Path: List.encounter
  - INCLUDE_ENCOUNTER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ListResource:encounter".
  - SP_TITLE
```
public static final String SP_TITLE
```
    Search parameter: title
    Description: Descriptive name for the list
    Type: string
    Path: List.title
    
    See Also:
    
    Constant Field Values
  - TITLE
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
```
    Fluent Client search parameter constant for title
    Description: Descriptive name for the list
    Type: string
    Path: List.title
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: current | retired | entered-in-error
    Type: token
    Path: List.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: current | retired | entered-in-error
    Type: token
    Path: List.status
- Constructor Detail
  - ListResource
```
public ListResource()
```
    Constructor
  - ListResource
```
public ListResource(Enumeration<ListResource.ListStatus> status,
                    Enumeration<ListResource.ListMode> mode)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Identifier for the List assigned for business purposes outside the context of FHIR.)
  - setIdentifier
```
public ListResource setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public ListResource addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getStatusElement
```
public Enumeration<ListResource.ListStatus> getStatusElement()
```
    Returns:
    
    status (Indicates the current state of this list.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public ListResource setStatusElement(Enumeration<ListResource.ListStatus> value)
```
    Parameters:
    
    value - status (Indicates the current state of this list.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public ListResource.ListStatus getStatus()
```
    Returns:
    
    Indicates the current state of this list.
  - setStatus
```
public ListResource setStatus(ListResource.ListStatus value)
```
    Parameters:
    
    value - Indicates the current state of this list.
  - getModeElement
```
public Enumeration<ListResource.ListMode> getModeElement()
```
    Returns:
    
    mode (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.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
  - hasModeElement
```
public boolean hasModeElement()
```
  - hasMode
```
public boolean hasMode()
```
  - setModeElement
```
public ListResource setModeElement(Enumeration<ListResource.ListMode> value)
```
    Parameters:
    
    value - mode (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.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
  - getMode
```
public ListResource.ListMode getMode()
```
    Returns:
    
    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.
  - setMode
```
public ListResource setMode(ListResource.ListMode value)
```
    Parameters:
    
    value - 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.
  - getTitleElement
```
public StringType getTitleElement()
```
    Returns:
    
    title (A label for the list assigned by the author.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - hasTitleElement
```
public boolean hasTitleElement()
```
  - hasTitle
```
public boolean hasTitle()
```
  - setTitleElement
```
public ListResource setTitleElement(StringType value)
```
    Parameters:
    
    value - title (A label for the list assigned by the author.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - getTitle
```
public String getTitle()
```
    Returns:
    
    A label for the list assigned by the author.
  - setTitle
```
public ListResource setTitle(String value)
```
    Parameters:
    
    value - A label for the list assigned by the author.
  - getCode
```
public CodeableConcept getCode()
```
    Returns:
    
    code (This code defines the purpose of the list - why it was created.)
  - hasCode
```
public boolean hasCode()
```
  - setCode
```
public ListResource setCode(CodeableConcept value)
```
    Parameters:
    
    value - code (This code defines the purpose of the list - why it was created.)
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (The common subject (or patient) of the resources that are in the list if there is one.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public ListResource setSubject(Reference value)
```
    Parameters:
    
    value - subject (The common subject (or patient) of the resources that are in the list if there is one.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject 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 common subject (or patient) of the resources that are in the list if there is one.)
  - setSubjectTarget
```
public ListResource setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject 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 common subject (or patient) of the resources that are in the list if there is one.)
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (The encounter that is the context in which this list was created.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public ListResource setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (The encounter that is the context in which this list was created.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter 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 encounter that is the context in which this list was created.)
  - setEncounterTarget
```
public ListResource setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter 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 encounter that is the context in which this list was created.)
  - getDateElement
```
public DateTimeType getDateElement()
```
    Returns:
    
    date (The date that the list was prepared.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - hasDateElement
```
public boolean hasDateElement()
```
  - hasDate
```
public boolean hasDate()
```
  - setDateElement
```
public ListResource setDateElement(DateTimeType value)
```
    Parameters:
    
    value - date (The date that the list was prepared.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Returns:
    
    The date that the list was prepared.
  - setDate
```
public ListResource setDate(Date value)
```
    Parameters:
    
    value - The date that the list was prepared.
  - getSource
```
public Reference getSource()
```
    Returns:
    
    source (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.)
  - hasSource
```
public boolean hasSource()
```
  - setSource
```
public ListResource setSource(Reference value)
```
    Parameters:
    
    value - source (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.)
  - getSourceTarget
```
public Resource getSourceTarget()
```
    Returns:
    
    source 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 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.)
  - setSourceTarget
```
public ListResource setSourceTarget(Resource value)
```
    Parameters:
    
    value - source 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 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.)
  - getOrderedBy
```
public CodeableConcept getOrderedBy()
```
    Returns:
    
    orderedBy (What order applies to the items in the list.)
  - hasOrderedBy
```
public boolean hasOrderedBy()
```
  - setOrderedBy
```
public ListResource setOrderedBy(CodeableConcept value)
```
    Parameters:
    
    value - orderedBy (What order applies to the items in the list.)
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Comments that apply to the overall list.)
  - setNote
```
public ListResource setNote(List<Annotation> theNote)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
  - addNote
```
public ListResource addNote(Annotation t)
```
  - getNoteFirstRep
```
public Annotation getNoteFirstRep()
```
    Returns:
    
    The first repetition of repeating field note, creating it if it does not already exist
  - getEntry
```
public List<ListResource.ListEntryComponent> getEntry()
```
    Returns:
    
    entry (Entries in this list.)
  - setEntry
```
public ListResource setEntry(List<ListResource.ListEntryComponent> theEntry)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasEntry
```
public boolean hasEntry()
```
  - addEntry
```
public ListResource.ListEntryComponent addEntry()
```
  - addEntry
```
public ListResource addEntry(ListResource.ListEntryComponent t)
```
  - getEntryFirstRep
```
public ListResource.ListEntryComponent getEntryFirstRep()
```
    Returns:
    
    The first repetition of repeating field entry, creating it if it does not already exist
  - getEmptyReason
```
public CodeableConcept getEmptyReason()
```
    Returns:
    
    emptyReason (If the list is empty, why the list is empty.)
  - hasEmptyReason
```
public boolean hasEmptyReason()
```
  - setEmptyReason
```
public ListResource setEmptyReason(CodeableConcept value)
```
    Parameters:
    
    value - emptyReason (If the list is empty, why the list is empty.)
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    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 DomainResource
  - copy
```
public ListResource copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(ListResource dst)
```
  - typedCopy
```
protected ListResource typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class ListResource

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

Fields inherited from class org.hl7.fhir.r4.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

Methods inherited from class org.hl7.fhir.r4.model.Resource

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

status

mode

title

code

subject

subjectTarget

encounter

encounterTarget

date

source

sourceTarget

orderedBy

note

entry

emptyReason

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_ITEM

ITEM

INCLUDE_ITEM

SP_EMPTY_REASON

EMPTY_REASON

SP_CODE

CODE

SP_NOTES

NOTES

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_SOURCE

SOURCE

INCLUDE_SOURCE

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

SP_TITLE

TITLE

SP_STATUS

STATUS

Constructor Detail

ListResource

ListResource

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getModeElement