ListResource (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.ListResource

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class ListResource
extends BaseResource
implements IResource
```
HAPI/FHIR List Resource (Information summarized from a list of other resources)
Definition: A set of information summarized from a list of other resources

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/List

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ListResource.Entry
Block class for child element: List.entry (Entries in the list)

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListResource.Entry` Block class for child element: List.entry (Entries in the list)

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static TokenClientParam`	`EMPTY_REASON` Fluent Client search parameter constant for empty-reason
`static Include`	`INCLUDE_ENTRY_ITEM` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SOURCE` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`ITEM` Fluent Client search parameter constant for item
`static ReferenceClientParam`	`SOURCE` Fluent Client search parameter constant for source
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_EMPTY_REASON` Search parameter constant for empty-reason
`static String`	`SP_ITEM` Search parameter constant for item
`static String`	`SP_SOURCE` Search parameter constant for source
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

ListResource()

Constructors
Constructor and Description
`ListResource()`

Method Summary

Methods
Modifier and Type	Method and Description
`ListResource.Entry`	`addEntry()` Adds and returns a new value for entry (Entries in the list)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (Business identifier)
`ListResource`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (Business identifier)
`ListResource`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (Business identifier)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`CodeableConceptDt`	`getCode()` Gets the value(s) for code (What the purpose of this list is).
`DateTimeDt`	`getDate()` Gets the value(s) for date (When the list was prepared).
`CodeableConceptDt`	`getEmptyReason()` Gets the value(s) for emptyReason (Why list is empty).
`List<ListResource.Entry>`	`getEntry()` Gets the value(s) for entry (Entries in the list).
`ListResource.Entry`	`getEntryFirstRep()` Gets the first repetition for entry (Entries in the list), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (Business identifier).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (Business identifier), creating it if it does not already exist.
`BoundCodeDt<ListModeEnum>`	`getMode()` Gets the value(s) for mode (working \| snapshot \| changes).
`BooleanDt`	`getOrdered()` Gets the value(s) for ordered (Whether items in the list have a meaningful order).
`ResourceReferenceDt`	`getSource()` Gets the value(s) for source (Who and/or what defined the list contents).
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (If all resources have the same subject).
`boolean`	`isEmpty()`
`ListResource`	`setCode(CodeableConceptDt theValue)` Sets the value(s) for code (What the purpose of this list is)
`ListResource`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (When the list was prepared)
`ListResource`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (When the list was prepared)
`ListResource`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (When the list was prepared)
`ListResource`	`setEmptyReason(CodeableConceptDt theValue)` Sets the value(s) for emptyReason (Why list is empty)
`ListResource`	`setEntry(List<ListResource.Entry> theValue)` Sets the value(s) for entry (Entries in the list)
`ListResource`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (Business identifier)
`ListResource`	`setMode(BoundCodeDt<ListModeEnum> theValue)` Sets the value(s) for mode (working \| snapshot \| changes)
`ListResource`	`setMode(ListModeEnum theValue)` Sets the value(s) for mode (working \| snapshot \| changes)
`ListResource`	`setOrdered(boolean theBoolean)` Sets the value for ordered (Whether items in the list have a meaningful order)
`ListResource`	`setOrdered(BooleanDt theValue)` Sets the value(s) for ordered (Whether items in the list have a meaningful order)
`ListResource`	`setSource(ResourceReferenceDt theValue)` Sets the value(s) for source (Who and/or what defined the list contents)
`ListResource`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (If all resources have the same subject)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter constant for source
    Description:
    Type: reference
    Path: List.source
    
    See Also:
    Constant Field Values
  - SOURCE
```
public static final ReferenceClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description:
    Type: reference
    Path: List.source
  - INCLUDE_SOURCE
```
public static final Include INCLUDE_SOURCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "List.source".
  - SP_ITEM
```
public static final String SP_ITEM
```
    Search parameter constant for item
    Description:
    Type: reference
    Path: List.entry.item
    
    See Also:
    Constant Field Values
  - ITEM
```
public static final ReferenceClientParam ITEM
```
    Fluent Client search parameter constant for item
    Description:
    Type: reference
    Path: List.entry.item
  - INCLUDE_ENTRY_ITEM
```
public static final Include INCLUDE_ENTRY_ITEM
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "List.entry.item".
  - SP_EMPTY_REASON
```
public static final String SP_EMPTY_REASON
```
    Search parameter constant for empty-reason
    Description:
    Type: token
    Path: List.emptyReason
    
    See Also:
    Constant Field Values
  - EMPTY_REASON
```
public static final TokenClientParam EMPTY_REASON
```
    Fluent Client search parameter constant for empty-reason
    Description:
    Type: token
    Path: List.emptyReason
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: List.date
    
    See Also:
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: List.date
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description:
    Type: token
    Path: List.code
    
    See Also:
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description:
    Type: token
    Path: List.code
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description:
    Type: reference
    Path: List.subject
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description:
    Type: reference
    Path: List.subject
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "List.subject".
- Constructor Detail
  - ListResource
```
public ListResource()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (Business identifier). creating it if it does not exist. Will not return null.
    Definition: Identifier for the List assigned for business purposes outside the context of FHIR.
  - setIdentifier
```
public ListResource setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (Business identifier)
    Definition: Identifier for the List assigned for business purposes outside the context of FHIR.
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (Business identifier)
    Definition: Identifier for the List assigned for business purposes outside the context of FHIR.
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (Business identifier), creating it if it does not already exist.
    Definition: Identifier for the List assigned for business purposes outside the context of FHIR.
  - addIdentifier
```
public ListResource addIdentifier(IdentifierUseEnum theUse,
                         String theSystem,
                         String theValue,
                         String theLabel)
```
    Adds a new value for identifier (Business identifier)
    Definition: Identifier for the List assigned for business purposes outside the context of FHIR.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public ListResource addIdentifier(String theSystem,
                         String theValue)
```
    Adds a new value for identifier (Business identifier)
    Definition: Identifier for the List assigned for business purposes outside the context of FHIR.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getCode
```
public CodeableConceptDt getCode()
```
    Gets the value(s) for code (What the purpose of this list is). creating it if it does not exist. Will not return null.
    Definition: This code defines the purpose of the list - why it was created
  - setCode
```
public ListResource setCode(CodeableConceptDt theValue)
```
    Sets the value(s) for code (What the purpose of this list is)
    Definition: This code defines the purpose of the list - why it was created
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (If all resources have the same subject). creating it if it does not exist. Will not return null.
    Definition: The common subject (or patient) of the resources that are in the list, if there is one
  - setSubject
```
public ListResource setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (If all resources have the same subject)
    Definition: The common subject (or patient) of the resources that are in the list, if there is one
  - getSource
```
public ResourceReferenceDt getSource()
```
    Gets the value(s) for source (Who and/or what defined the list contents). creating it if it does not exist. Will not return null.
    Definition: The entity responsible for deciding what the contents of the list were
  - setSource
```
public ListResource setSource(ResourceReferenceDt theValue)
```
    Sets the value(s) for source (Who and/or what defined the list contents)
    Definition: The entity responsible for deciding what the contents of the list were
  - getDate
```
public DateTimeDt getDate()
```
    Gets the value(s) for date (When the list was prepared). creating it if it does not exist. Will not return null.
    Definition: The date that the list was prepared
  - setDate
```
public ListResource setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (When the list was prepared)
    Definition: The date that the list was prepared
  - setDateWithSecondsPrecision
```
public ListResource setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (When the list was prepared)
    Definition: The date that the list was prepared
  - setDate
```
public ListResource setDate(Date theDate,
                   TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (When the list was prepared)
    Definition: The date that the list was prepared
  - getOrdered
```
public BooleanDt getOrdered()
```
    Gets the value(s) for ordered (Whether items in the list have a meaningful order). creating it if it does not exist. Will not return null.
    Definition: Whether items in the list have a meaningful order
  - setOrdered
```
public ListResource setOrdered(BooleanDt theValue)
```
    Sets the value(s) for ordered (Whether items in the list have a meaningful order)
    Definition: Whether items in the list have a meaningful order
  - setOrdered
```
public ListResource setOrdered(boolean theBoolean)
```
    Sets the value for ordered (Whether items in the list have a meaningful order)
    Definition: Whether items in the list have a meaningful order
  - getMode
```
public BoundCodeDt<ListModeEnum> getMode()
```
    Gets the value(s) for mode (working | snapshot | changes). creating it if it does not exist. Will not return null.
    Definition: 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(BoundCodeDt<ListModeEnum> theValue)
```
    Sets the value(s) for mode (working | snapshot | changes)
    Definition: 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(ListModeEnum theValue)
```
    Sets the value(s) for mode (working | snapshot | changes)
    Definition: 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
  - getEntry
```
public List<ListResource.Entry> getEntry()
```
    Gets the value(s) for entry (Entries in the list). creating it if it does not exist. Will not return null.
    Definition: Entries in this list
  - setEntry
```
public ListResource setEntry(List<ListResource.Entry> theValue)
```
    Sets the value(s) for entry (Entries in the list)
    Definition: Entries in this list
  - addEntry
```
public ListResource.Entry addEntry()
```
    Adds and returns a new value for entry (Entries in the list)
    Definition: Entries in this list
  - getEntryFirstRep
```
public ListResource.Entry getEntryFirstRep()
```
    Gets the first repetition for entry (Entries in the list), creating it if it does not already exist.
    Definition: Entries in this list
  - getEmptyReason
```
public CodeableConceptDt getEmptyReason()
```
    Gets the value(s) for emptyReason (Why list is empty). creating it if it does not exist. Will not return null.
    Definition: If the list is empty, why the list is empty
  - setEmptyReason
```
public ListResource setEmptyReason(CodeableConceptDt theValue)
```
    Sets the value(s) for emptyReason (Why list is empty)
    Definition: If the list is empty, why the list is empty

Class ListResource

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_SOURCE

SOURCE

INCLUDE_SOURCE

SP_ITEM

ITEM

INCLUDE_ENTRY_ITEM

SP_EMPTY_REASON

EMPTY_REASON

SP_DATE

DATE

SP_CODE

CODE

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

Constructor Detail

ListResource

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getCode

setCode

getSubject

setSubject

getSource

setSource

getDate

setDate

setDateWithSecondsPrecision

setDate

getOrdered

setOrdered

setOrdered

getMode

setMode

setMode

getEntry

setEntry

addEntry

getEntryFirstRep

getEmptyReason

setEmptyReason