Class 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 set of information summarized from a list of other resources.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        Identifier for the List assigned for business purposes outside the context of FHIR.
      • 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.)
      • 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.)
      • 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

      • 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

      • 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".
      • 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
        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
        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