Group (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Group

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Group
extends BaseResource
implements IResource
```
HAPI/FHIR Group Resource (administrative.group)
Definition: 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.

Requirements:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Group.Characteristic` Block class for child element: Group.characteristic ()
`static class`	`Group.Member` Block class for child element: Group.member ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACTUAL` Fluent Client search parameter constant for actual
`static TokenClientParam`	`CHARACTERISTIC` Fluent Client search parameter constant for characteristic
`static CompositeClientParam<TokenClientParam,TokenClientParam>`	`CHARACTERISTIC_VALUE` Fluent Client search parameter constant for characteristic-value
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static TokenClientParam`	`EXCLUDE` Fluent Client search parameter constant for exclude
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_MEMBER` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`MEMBER` Fluent Client search parameter constant for member
`static String`	`SP_ACTUAL` Search parameter constant for actual
`static String`	`SP_CHARACTERISTIC` Search parameter constant for characteristic
`static String`	`SP_CHARACTERISTIC_VALUE` Search parameter constant for characteristic-value
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_EXCLUDE` Search parameter constant for exclude
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_MEMBER` Search parameter constant for member
`static String`	`SP_TYPE` Search parameter constant for type
`static String`	`SP_VALUE` Search parameter constant for value
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type
`static TokenClientParam`	`VALUE` Fluent Client search parameter constant for value

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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

Group()

Constructors
Constructor and Description
`Group()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Group.Characteristic`	`addCharacteristic()` Adds and returns a new value for characteristic ()
`Group`	`addCharacteristic(Group.Characteristic theValue)` Adds a given new value for characteristic ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Group`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`Group.Member`	`addMember()` Adds and returns a new value for member ()
`Group`	`addMember(Group.Member theValue)` Adds a given new value for member ()
`Boolean`	`getActual()` Gets the value(s) for actual ().
`BooleanDt`	`getActualElement()` Gets the value(s) for actual ().
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`List<Group.Characteristic>`	`getCharacteristic()` Gets the value(s) for characteristic ().
`Group.Characteristic`	`getCharacteristicFirstRep()` Gets the first repetition for characteristic (), creating it if it does not already exist.
`CodeableConceptDt`	`getCode()` Gets the value(s) for code ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`List<Group.Member>`	`getMember()` Gets the value(s) for member ().
`Group.Member`	`getMemberFirstRep()` Gets the first repetition for member (), creating it if it does not already exist.
`String`	`getName()` Gets the value(s) for name ().
`StringDt`	`getNameElement()` Gets the value(s) for name ().
`Integer`	`getQuantity()` Gets the value(s) for quantity ().
`UnsignedIntDt`	`getQuantityElement()` Gets the value(s) for quantity ().
`String`	`getResourceName()`
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`String`	`getType()` Gets the value(s) for type (class).
`BoundCodeDt<GroupTypeEnum>`	`getTypeElement()` Gets the value(s) for type (class).
`boolean`	`isEmpty()`
`Group`	`setActual(boolean theBoolean)` Sets the value for actual ()
`Group`	`setActual(BooleanDt theValue)` Sets the value(s) for actual ()
`Group`	`setCharacteristic(List<Group.Characteristic> theValue)` Sets the value(s) for characteristic ()
`Group`	`setCode(CodeableConceptDt theValue)` Sets the value(s) for code ()
`Group`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Group`	`setMember(List<Group.Member> theValue)` Sets the value(s) for member ()
`Group`	`setName(String theString)` Sets the value for name ()
`Group`	`setName(StringDt theValue)` Sets the value(s) for name ()
`Group`	`setQuantity(int theInteger)` Sets the value for quantity ()
`Group`	`setQuantity(UnsignedIntDt theValue)` Sets the value(s) for quantity ()
`Group`	`setType(BoundCodeDt<GroupTypeEnum> theValue)` Sets the value(s) for type (class)
`Group`	`setType(GroupTypeEnum theValue)` Sets the value(s) for type (class)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, 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

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

- Field Detail
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description: The type of resources the group contains
    Type: token
    Path: Group.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: The type of resources the group contains
    Type: token
    Path: Group.type
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description: The kind of resources contained
    Type: token
    Path: Group.code
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description: The kind of resources contained
    Type: token
    Path: Group.code
  - SP_ACTUAL
```
public static final String SP_ACTUAL
```
    Search parameter constant for actual
    Description:
    Type: token
    Path: Group.actual
    
    See Also:
    
    Constant Field Values
  - ACTUAL
```
public static final TokenClientParam ACTUAL
```
    Fluent Client search parameter constant for actual
    Description:
    Type: token
    Path: Group.actual
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description:
    Type: token
    Path: Group.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description:
    Type: token
    Path: Group.identifier
  - SP_MEMBER
```
public static final String SP_MEMBER
```
    Search parameter constant for member
    Description:
    Type: reference
    Path: Group.member.entity
    
    See Also:
    
    Constant Field Values
  - MEMBER
```
public static final ReferenceClientParam MEMBER
```
    Fluent Client search parameter constant for member
    Description:
    Type: reference
    Path: Group.member.entity
  - SP_CHARACTERISTIC
```
public static final String SP_CHARACTERISTIC
```
    Search parameter constant for characteristic
    Description:
    Type: token
    Path: Group.characteristic.code
    
    See Also:
    
    Constant Field Values
  - CHARACTERISTIC
```
public static final TokenClientParam CHARACTERISTIC
```
    Fluent Client search parameter constant for characteristic
    Description:
    Type: token
    Path: Group.characteristic.code
  - SP_VALUE
```
public static final String SP_VALUE
```
    Search parameter constant for value
    Description:
    Type: token
    Path: Group.characteristic.value[x]
    
    See Also:
    
    Constant Field Values
  - VALUE
```
public static final TokenClientParam VALUE
```
    Fluent Client search parameter constant for value
    Description:
    Type: token
    Path: Group.characteristic.value[x]
  - SP_EXCLUDE
```
public static final String SP_EXCLUDE
```
    Search parameter constant for exclude
    Description:
    Type: token
    Path: Group.characteristic.exclude
    
    See Also:
    
    Constant Field Values
  - EXCLUDE
```
public static final TokenClientParam EXCLUDE
```
    Fluent Client search parameter constant for exclude
    Description:
    Type: token
    Path: Group.characteristic.exclude
  - SP_CHARACTERISTIC_VALUE
```
public static final String SP_CHARACTERISTIC_VALUE
```
    Search parameter constant for characteristic-value
    Description: A composite of both characteristic and value
    Type: composite
    Path: characteristic & value
    
    See Also:
    
    Constant Field Values
  - CHARACTERISTIC_VALUE
```
public static final CompositeClientParam<TokenClientParam,TokenClientParam> CHARACTERISTIC_VALUE
```
    Fluent Client search parameter constant for characteristic-value
    Description: A composite of both characteristic and value
    Type: composite
    Path: characteristic & value
  - INCLUDE_MEMBER
```
public static final Include INCLUDE_MEMBER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Group:member".
- Constructor Detail
  - Group
```
public Group()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface 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: A unique business identifier for this group
  - setIdentifier
```
public Group setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition: A unique business identifier for this group
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition: A unique business identifier for this group
  - addIdentifier
```
public Group addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition: A unique business identifier for this group
    
    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: A unique business identifier for this group
  - getTypeElement
```
public BoundCodeDt<GroupTypeEnum> getTypeElement()
```
    Gets the value(s) for type (class). creating it if it does not exist. Will not return null.
    Definition: Identifies the broad classification of the kind of resources the group includes
  - getType
```
public String getType()
```
    Gets the value(s) for type (class). creating it if it does not exist. Will not return null.
    Definition: Identifies the broad classification of the kind of resources the group includes
  - setType
```
public Group setType(BoundCodeDt<GroupTypeEnum> theValue)
```
    Sets the value(s) for type (class)
    Definition: Identifies the broad classification of the kind of resources the group includes
  - setType
```
public Group setType(GroupTypeEnum theValue)
```
    Sets the value(s) for type (class)
    Definition: Identifies the broad classification of the kind of resources the group includes
  - getActualElement
```
public BooleanDt getActualElement()
```
    Gets the value(s) for actual (). creating it if it does not exist. Will not return null.
    Definition: If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals
  - getActual
```
public Boolean getActual()
```
    Gets the value(s) for actual (). creating it if it does not exist. Will not return null.
    Definition: 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(BooleanDt theValue)
```
    Sets the value(s) for actual ()
    Definition: 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 theBoolean)
```
    Sets the value for actual ()
    Definition: If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals
  - getCode
```
public CodeableConceptDt getCode()
```
    Gets the value(s) for code (). creating it if it does not exist. Will not return null.
    Definition: Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.
  - setCode
```
public Group setCode(CodeableConceptDt theValue)
```
    Sets the value(s) for code ()
    Definition: Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.
  - getNameElement
```
public StringDt getNameElement()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: A label assigned to the group for human identification and communication
  - getName
```
public String getName()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: A label assigned to the group for human identification and communication
  - setName
```
public Group setName(StringDt theValue)
```
    Sets the value(s) for name ()
    Definition: A label assigned to the group for human identification and communication
  - setName
```
public Group setName(String theString)
```
    Sets the value for name ()
    Definition: A label assigned to the group for human identification and communication
  - getQuantityElement
```
public UnsignedIntDt getQuantityElement()
```
    Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.
    Definition: A count of the number of resource instances that are part of the group
  - getQuantity
```
public Integer getQuantity()
```
    Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.
    Definition: A count of the number of resource instances that are part of the group
  - setQuantity
```
public Group setQuantity(UnsignedIntDt theValue)
```
    Sets the value(s) for quantity ()
    Definition: A count of the number of resource instances that are part of the group
  - setQuantity
```
public Group setQuantity(int theInteger)
```
    Sets the value for quantity ()
    Definition: A count of the number of resource instances that are part of the group
  - getCharacteristic
```
public List<Group.Characteristic> getCharacteristic()
```
    Gets the value(s) for characteristic (). creating it if it does not exist. Will not return null.
    Definition: Identifies the traits shared by members of the group
  - setCharacteristic
```
public Group setCharacteristic(List<Group.Characteristic> theValue)
```
    Sets the value(s) for characteristic ()
    Definition: Identifies the traits shared by members of the group
  - addCharacteristic
```
public Group.Characteristic addCharacteristic()
```
    Adds and returns a new value for characteristic ()
    Definition: Identifies the traits shared by members of the group
  - addCharacteristic
```
public Group addCharacteristic(Group.Characteristic theValue)
```
    Adds a given new value for characteristic ()
    Definition: Identifies the traits shared by members of the group
    
    Parameters:
    
    theValue - The characteristic to add (must not be null)
  - getCharacteristicFirstRep
```
public Group.Characteristic getCharacteristicFirstRep()
```
    Gets the first repetition for characteristic (), creating it if it does not already exist.
    Definition: Identifies the traits shared by members of the group
  - getMember
```
public List<Group.Member> getMember()
```
    Gets the value(s) for member (). creating it if it does not exist. Will not return null.
    Definition: Identifies the resource instances that are members of the group.
  - setMember
```
public Group setMember(List<Group.Member> theValue)
```
    Sets the value(s) for member ()
    Definition: Identifies the resource instances that are members of the group.
  - addMember
```
public Group.Member addMember()
```
    Adds and returns a new value for member ()
    Definition: Identifies the resource instances that are members of the group.
  - addMember
```
public Group addMember(Group.Member theValue)
```
    Adds a given new value for member ()
    Definition: Identifies the resource instances that are members of the group.
    
    Parameters:
    
    theValue - The member to add (must not be null)
  - getMemberFirstRep
```
public Group.Member getMemberFirstRep()
```
    Gets the first repetition for member (), creating it if it does not already exist.
    Definition: Identifies the resource instances that are members of the group.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Group

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.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

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

Field Detail

SP_TYPE

TYPE

SP_CODE

CODE

SP_ACTUAL

ACTUAL

SP_IDENTIFIER

IDENTIFIER

SP_MEMBER

MEMBER

SP_CHARACTERISTIC

CHARACTERISTIC

SP_VALUE

VALUE

SP_EXCLUDE

EXCLUDE

SP_CHARACTERISTIC_VALUE

CHARACTERISTIC_VALUE

INCLUDE_MEMBER

Constructor Detail

Group

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getTypeElement

getType

setType

setType

getActualElement

getActual

setActual

setActual

getCode

setCode

getNameElement

getName

setName

setName

getQuantityElement

getQuantity

setQuantity

setQuantity

getCharacteristic

setCharacteristic

addCharacteristic

addCharacteristic

getCharacteristicFirstRep

getMember

setMember

addMember

addMember

getMemberFirstRep

getResourceName

getStructureFhirVersionEnum