Package ca.uhn.fhir.model.dstu2.resource

Class ListResource

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
    public class ListResource
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR List Resource (infrastructure.documents)

    Definition: A set of information summarized from a list of other resources.

    Requirements:

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

    See Also:
    Serialized Form

    • Field Detail

      • SOURCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
        Fluent Client search parameter constant for source

        Description:
        Type: reference
        Path: List.source

      • ITEM

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ITEM
        Fluent Client search parameter constant for item

        Description:
        Type: reference
        Path: List.entry.item

      • EMPTY_REASON

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMPTY_REASON
        Fluent Client search parameter constant for empty-reason

        Description:
        Type: token
        Path: List.emptyReason

      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description:
        Type: date
        Path: List.date

      • CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
        Fluent Client search parameter constant for code

        Description:
        Type: token
        Path: List.code

      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description:
        Type: reference
        Path: List.subject

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: List.subject

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description:
        Type: token
        Path: List.status

      • TITLE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
        Fluent Client search parameter constant for title

        Description:
        Type: string
        Path: List.title

      • NOTES

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NOTES
        Fluent Client search parameter constant for notes

        Description:
        Type: string
        Path: List.note

      • ENCOUNTER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
        Fluent Client search parameter constant for encounter

        Description:
        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 "List:encounter".

      • 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 "List:item".

      • 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 "List:patient".

      • 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 "List:source".

      • 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 "List:subject".

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase

      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

      • getIdentifier

        public List<IdentifierDt> getIdentifier()
        Gets the value(s) for identifier (id). 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 (id)

        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 (id)

        Definition: Identifier for the List assigned for business purposes outside the context of FHIR.

      • addIdentifier

        public ListResource addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: Identifier for the List assigned for business purposes outside the context of FHIR.

        Parameters:
        theValue - The identifier to add (must not be null)

      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: Identifier for the List assigned for business purposes outside the context of FHIR.

      • getTitleElement

        public ca.uhn.fhir.model.primitive.StringDt getTitleElement()
        Gets the value(s) for title (). creating it if it does not exist. Will not return null.

        Definition: A label for the list assigned by the author

      • getTitle

        public String getTitle()
        Gets the value(s) for title (). creating it if it does not exist. This method may return null.

        Definition: A label for the list assigned by the author

      • setTitle

        public ListResource setTitle​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for title ()

        Definition: A label for the list assigned by the author

      • setTitle

        public ListResource setTitle​(String theString)
        Sets the value for title ()

        Definition: A label for the list assigned by the author

      • getCode

        public CodeableConceptDt getCode()
        Gets the value(s) for code (what). 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)

        Definition: This code defines the purpose of the list - why it was created

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (who.focus). 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 (who.focus)

        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.author). creating it if it does not exist. Will not return null.

        Definition: 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

      • setSource

        public ListResource setSource​(ResourceReferenceDt theValue)
        Sets the value(s) for source (who.author)

        Definition: 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

      • getEncounter

        public ResourceReferenceDt getEncounter()
        Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

        Definition: The encounter that is the context in which this list was created

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ListStatusEnum> getStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: Indicates the current state of this list

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: Indicates the current state of this list

      • setStatus

        public ListResource setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<ListStatusEnum> theValue)
        Sets the value(s) for status (status)

        Definition: Indicates the current state of this list

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

        Definition: The date that the list was prepared

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

        Definition: The date that the list was prepared

      • setDate

        public ListResource setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.recorded)

        Definition: The date that the list was prepared

      • setDate

        public ListResource setDate​(Date theDate,
                            ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.recorded)

        Definition: The date that the list was prepared

      • getModeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ListModeEnum> getModeElement()
        Gets the value(s) for mode (class). 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

      • getMode

        public String getMode()
        Gets the value(s) for mode (class). creating it if it does not exist. This method may 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​(ca.uhn.fhir.model.primitive.BoundCodeDt<ListModeEnum> theValue)
        Sets the value(s) for mode (class)

        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 (class)

        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

      • getNoteElement

        public ca.uhn.fhir.model.primitive.StringDt getNoteElement()
        Gets the value(s) for note (). creating it if it does not exist. Will not return null.

        Definition: Comments that apply to the overall list

      • getNote

        public String getNote()
        Gets the value(s) for note (). creating it if it does not exist. This method may return null.

        Definition: Comments that apply to the overall list

      • setNote

        public ListResource setNote​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for note ()

        Definition: Comments that apply to the overall list

      • setNote

        public ListResource setNote​(String theString)
        Sets the value for note ()

        Definition: Comments that apply to the overall list

      • getEntry

        public List<ListResource.Entry> getEntry()
        Gets the value(s) for entry (). creating it if it does not exist. Will not return null.

        Definition: Entries in this list

      • addEntry

        public ListResource addEntry​(ListResource.Entry theValue)
        Adds a given new value for entry ()

        Definition: Entries in this list

        Parameters:
        theValue - The entry to add (must not be null)

      • getEntryFirstRep

        public ListResource.Entry getEntryFirstRep()
        Gets the first repetition for entry (), creating it if it does not already exist.

        Definition: Entries in this list

      • getEmptyReason

        public CodeableConceptDt getEmptyReason()
        Gets the value(s) for emptyReason (). creating it if it does not exist. Will not return null.

        Definition: If the list is empty, why the list is empty

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource

      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource