Package org.hl7.fhir.dstu2016may.model

Class Group

  • 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 Group
extends DomainResource
    Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.
    See Also:
    Serialized Form

    • Field Detail

      • actual

        protected BooleanType actual
        If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

      • active

        protected BooleanType active
        Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

      • code

        protected CodeableConcept code
        Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.

      • name

        protected StringType name
        A label assigned to the group for human identification and communication.

      • quantity

        protected UnsignedIntType quantity
        A count of the number of resource instances that are part of the group.

      • SP_MEMBER

        public static final String SP_MEMBER
        Search parameter: member

        Description: Reference to the group member
        Type: reference
        Path: Group.member.entity

        See Also:
        Constant Field Values

      • MEMBER

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

        Description: Reference to the group member
        Type: reference
        Path: Group.member.entity

      • INCLUDE_MEMBER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_MEMBER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Group:member".

      • CHARACTERISTIC_VALUE

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.TokenClientParam> CHARACTERISTIC_VALUE
        Fluent Client search parameter constant for characteristic-value

        Description: A composite of both characteristic and value
        Type: composite
        Path:

      • SP_VALUE

        public static final String SP_VALUE
        Search parameter: value

        Description: Value held by characteristic
        Type: token
        Path: Group.characteristic.value[x]

        See Also:
        Constant Field Values

      • VALUE

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

        Description: Value held by characteristic
        Type: token
        Path: Group.characteristic.value[x]

      • ACTUAL

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

        Description: Descriptive or actual
        Type: token
        Path: Group.actual

      • SP_EXCLUDE

        public static final String SP_EXCLUDE
        Search parameter: exclude

        Description: Group includes or excludes
        Type: token
        Path: Group.characteristic.exclude

        See Also:
        Constant Field Values

      • EXCLUDE

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

        Description: Group includes or excludes
        Type: token
        Path: Group.characteristic.exclude

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: The kind of resources contained
        Type: token
        Path: Group.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: The kind of resources contained
        Type: token
        Path: Group.code

      • CHARACTERISTIC

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

        Description: Kind of characteristic
        Type: token
        Path: Group.characteristic.code

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: The type of resources the group contains
        Type: token
        Path: Group.type

        See Also:
        Constant Field Values

      • TYPE

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

        Description: The type of resources the group contains
        Type: token
        Path: Group.type

      • IDENTIFIER

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

        Description: Unique id
        Type: token
        Path: Group.identifier

    • Method Detail

      • getTypeElement

        public Enumeration<Group.GroupType> getTypeElement()
        Returns:
        type (Identifies the broad classification of the kind of resources the group includes.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

      • hasType

        public boolean hasType()

      • setTypeElement

        public Group setTypeElement​(Enumeration<Group.GroupType> value)
        Parameters:
        value - type (Identifies the broad classification of the kind of resources the group includes.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

      • getType

        public Group.GroupType getType()
        Returns:
        Identifies the broad classification of the kind of resources the group includes.

      • setType

        public Group setType​(Group.GroupType value)
        Parameters:
        value - Identifies the broad classification of the kind of resources the group includes.

      • getActualElement

        public BooleanType getActualElement()
        Returns:
        actual (If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.). This is the underlying object with id, value and extensions. The accessor "getActual" gives direct access to the value

      • setActualElement

        public Group setActualElement​(BooleanType value)
        Parameters:
        value - actual (If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.). This is the underlying object with id, value and extensions. The accessor "getActual" gives direct access to the value

      • getActual

        public boolean getActual()
        Returns:
        If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

      • setActual

        public Group setActual​(boolean value)
        Parameters:
        value - If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

      • getActiveElement

        public BooleanType getActiveElement()
        Returns:
        active (Indicates whether the record for the group is available for use or is merely being retained for historical purposes.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

      • setActiveElement

        public Group setActiveElement​(BooleanType value)
        Parameters:
        value - active (Indicates whether the record for the group is available for use or is merely being retained for historical purposes.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

      • getActive

        public boolean getActive()
        Returns:
        Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

      • setActive

        public Group setActive​(boolean value)
        Parameters:
        value - Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

      • getCode

        public CodeableConcept getCode()
        Returns:
        code (Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.)

      • hasCode

        public boolean hasCode()

      • setCode

        public Group setCode​(CodeableConcept value)
        Parameters:
        value - code (Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.)

      • getNameElement

        public StringType getNameElement()
        Returns:
        name (A label assigned to the group for human identification and communication.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • hasName

        public boolean hasName()

      • setNameElement

        public Group setNameElement​(StringType value)
        Parameters:
        value - name (A label assigned to the group for human identification and communication.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • getName

        public String getName()
        Returns:
        A label assigned to the group for human identification and communication.

      • setName

        public Group setName​(String value)
        Parameters:
        value - A label assigned to the group for human identification and communication.

      • getQuantityElement

        public UnsignedIntType getQuantityElement()
        Returns:
        quantity (A count of the number of resource instances that are part of the group.). This is the underlying object with id, value and extensions. The accessor "getQuantity" gives direct access to the value

      • setQuantityElement

        public Group setQuantityElement​(UnsignedIntType value)
        Parameters:
        value - quantity (A count of the number of resource instances that are part of the group.). This is the underlying object with id, value and extensions. The accessor "getQuantity" gives direct access to the value

      • getQuantity

        public int getQuantity()
        Returns:
        A count of the number of resource instances that are part of the group.

      • setQuantity

        public Group setQuantity​(int value)
        Parameters:
        value - A count of the number of resource instances that are part of the group.

      • 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

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

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