ca.uhn.fhir.model.dstu.resource

Class Group

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Group

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Group
extends BaseResource
implements IResource

HAPI/FHIR Group Resource (Group of multiple entities)

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.Characteristic Block class for child element: Group.characteristic (Trait of group members)

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.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Methods

Modifier and Type	Method and Description
Group.Characteristic	addCharacteristic() Adds and returns a new value for characteristic (Trait of group members)
ResourceReferenceDt	addMember() Adds and returns a new value for member (Who is in group)
BooleanDt	getActual() Gets the value(s) for actual (Descriptive or actual).
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<Group.Characteristic>	getCharacteristic() Gets the value(s) for characteristic (Trait of group members).
Group.Characteristic	getCharacteristicFirstRep() Gets the first repetition for characteristic (Trait of group members), creating it if it does not already exist.
CodeableConceptDt	getCode() Gets the value(s) for code (Kind of Group members).
IdentifierDt	getIdentifier() Gets the value(s) for identifier (Unique id).
List<ResourceReferenceDt>	getMember() Gets the value(s) for member (Who is in group).
StringDt	getName() Gets the value(s) for name (Label for Group).
IntegerDt	getQuantity() Gets the value(s) for quantity (Number of members).
BoundCodeDt<GroupTypeEnum>	getType() Gets the value(s) for type (person | animal | practitioner | device | medication | substance).
boolean	isEmpty()
Group	setActual(boolean theBoolean) Sets the value for actual (Descriptive or actual)
Group	setActual(BooleanDt theValue) Sets the value(s) for actual (Descriptive or actual)
Group	setCharacteristic(List<Group.Characteristic> theValue) Sets the value(s) for characteristic (Trait of group members)
Group	setCode(CodeableConceptDt theValue) Sets the value(s) for code (Kind of Group members)
Group	setIdentifier(IdentifierDt theValue) Sets the value(s) for identifier (Unique id)
Group	setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Sets the value for identifier (Unique id)
Group	setIdentifier(String theSystem, String theValue) Sets the value for identifier (Unique id)
Group	setMember(List<ResourceReferenceDt> theValue) Sets the value(s) for member (Who is in group)
Group	setName(String theString) Sets the value for name (Label for Group)
Group	setName(StringDt theValue) Sets the value(s) for name (Label for Group)
Group	setQuantity(int theInteger) Sets the value for quantity (Number of members)
Group	setQuantity(IntegerDt theValue) Sets the value(s) for quantity (Number of members)
Group	setType(BoundCodeDt<GroupTypeEnum> theValue) Sets the value(s) for type (person | animal | practitioner | device | medication | substance)
Group	setType(GroupTypeEnum theValue) Sets the value(s) for type (person | animal | practitioner | device | medication | substance)

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_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

See Also:

Constant Field Values

MEMBER

public static final ReferenceClientParam MEMBER

Fluent Client search parameter constant for member

Description:
Type: reference
Path: Group.member

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

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

Constructor Detail

Group

public Group()

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 IdentifierDt getIdentifier()

Gets the value(s) for identifier (Unique id). creating it if it does not exist. Will not return null.

Definition: A unique business identifier for this group

setIdentifier

public Group setIdentifier(IdentifierDt theValue)

Sets the value(s) for identifier (Unique id)

Definition: A unique business identifier for this group

setIdentifier

public Group setIdentifier(IdentifierUseEnum theUse,
                  String theSystem,
                  String theValue,
                  String theLabel)

Sets the value for identifier (Unique id)

Definition: A unique business identifier for this group

setIdentifier

public Group setIdentifier(String theSystem,
                  String theValue)

Sets the value for identifier (Unique id)

Definition: A unique business identifier for this group

getType

public BoundCodeDt<GroupTypeEnum> getType()

Gets the value(s) for type (person | animal | practitioner | device | medication | substance). 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 (person | animal | practitioner | device | medication | substance)

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 (person | animal | practitioner | device | medication | substance)

Definition: Identifies the broad classification of the kind of resources the group includes

getActual

public BooleanDt getActual()

Gets the value(s) for actual (Descriptive or 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 (Descriptive or 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 (Descriptive or 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 (Kind of Group members). 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 (Kind of Group members)

Definition: Provides a specific type of resource the group includes. E.g. \"cow\", \"syringe\", etc.

getName

public StringDt getName()

Gets the value(s) for name (Label for Group). 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 (Label for Group)

Definition: A label assigned to the group for human identification and communication

setName

public Group setName(String theString)

Sets the value for name (Label for Group)

Definition: A label assigned to the group for human identification and communication

getQuantity

public IntegerDt getQuantity()

Gets the value(s) for quantity (Number of members). 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(IntegerDt theValue)

Sets the value(s) for quantity (Number of members)

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 (Number of members)

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 (Trait of group members). 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 (Trait of group members)

Definition: Identifies the traits shared by members of the group

addCharacteristic

public Group.Characteristic addCharacteristic()

Adds and returns a new value for characteristic (Trait of group members)

Definition: Identifies the traits shared by members of the group

getCharacteristicFirstRep

public Group.Characteristic getCharacteristicFirstRep()

Gets the first repetition for characteristic (Trait of group members), creating it if it does not already exist.

Definition: Identifies the traits shared by members of the group

getMember

public List<ResourceReferenceDt> getMember()

Gets the value(s) for member (Who is in group). 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<ResourceReferenceDt> theValue)

Sets the value(s) for member (Who is in group)

Definition: Identifies the resource instances that are members of the group.

addMember

public ResourceReferenceDt addMember()

Adds and returns a new value for member (Who is in group)

Definition: Identifies the resource instances that are members of the group.