org.hl7.fhir.dstu3.model

Class Group

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.Group

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.GroupCharacteristicComponent
static class	Group.GroupMemberComponent
static class	Group.GroupType
static class	Group.GroupTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanType	active Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
protected BooleanType	actual If true, indicates that the resource refers to a specific group of real individuals.
static TokenClientParam	ACTUAL Fluent Client search parameter constant for actual
protected List<Group.GroupCharacteristicComponent>	characteristic Identifies the traits shared by members of the group.
static TokenClientParam	CHARACTERISTIC Fluent Client search parameter constant for characteristic
static CompositeClientParam<TokenClientParam,TokenClientParam>	CHARACTERISTIC_VALUE Fluent Client search parameter constant for characteristic-value
protected CodeableConcept	code Provides a specific type of resource the group includes; e.g.
static TokenClientParam	CODE Fluent Client search parameter constant for code
static TokenClientParam	EXCLUDE Fluent Client search parameter constant for exclude
protected List<Identifier>	identifier A unique business identifier for this group.
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.
protected List<Group.GroupMemberComponent>	member Identifies the resource instances that are members of the group.
static ReferenceClientParam	MEMBER Fluent Client search parameter constant for member
protected StringType	name A label assigned to the group for human identification and communication.
protected UnsignedIntType	quantity A count of the number of resource instances that are part of the group.
static String	SP_ACTUAL Search parameter: actual
static String	SP_CHARACTERISTIC Search parameter: characteristic
static String	SP_CHARACTERISTIC_VALUE Search parameter: characteristic-value
static String	SP_CODE Search parameter: code
static String	SP_EXCLUDE Search parameter: exclude
static String	SP_IDENTIFIER Search parameter: identifier
static String	SP_MEMBER Search parameter: member
static String	SP_TYPE Search parameter: type
static String	SP_VALUE Search parameter: value
protected Enumeration<Group.GroupType>	type Identifies the broad classification of the kind of resources the group includes.
static TokenClientParam	TYPE Fluent Client search parameter constant for type
static TokenClientParam	VALUE Fluent Client search parameter constant for value

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

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

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() Constructor
Group(Enumeration<Group.GroupType> type, BooleanType actual) Constructor

Method Summary

Modifier and Type	Method and Description
Group.GroupCharacteristicComponent	addCharacteristic()
Group	addCharacteristic(Group.GroupCharacteristicComponent t)
Base	addChild(String name)
Identifier	addIdentifier()
Group	addIdentifier(Identifier t)
Group.GroupMemberComponent	addMember()
Group	addMember(Group.GroupMemberComponent t)
Group	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
boolean	getActual()
BooleanType	getActualElement()
List<Group.GroupCharacteristicComponent>	getCharacteristic()
Group.GroupCharacteristicComponent	getCharacteristicFirstRep()
CodeableConcept	getCode()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Group.GroupMemberComponent>	getMember()
Group.GroupMemberComponent	getMemberFirstRep()
String	getName()
StringType	getNameElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
int	getQuantity()
UnsignedIntType	getQuantityElement()
ResourceType	getResourceType()
Group.GroupType	getType()
Enumeration<Group.GroupType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasActual()
boolean	hasActualElement()
boolean	hasCharacteristic()
boolean	hasCode()
boolean	hasIdentifier()
boolean	hasMember()
boolean	hasName()
boolean	hasNameElement()
boolean	hasQuantity()
boolean	hasQuantityElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
Group	setActive(boolean value)
Group	setActiveElement(BooleanType value)
Group	setActual(boolean value)
Group	setActualElement(BooleanType value)
Group	setCharacteristic(List<Group.GroupCharacteristicComponent> theCharacteristic)
Group	setCode(CodeableConcept value)
Group	setIdentifier(List<Identifier> theIdentifier)
Group	setMember(List<Group.GroupMemberComponent> theMember)
Group	setName(String value)
Group	setNameElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Group	setQuantity(int value)
Group	setQuantityElement(UnsignedIntType value)
Group	setType(Group.GroupType value)
Group	setTypeElement(Enumeration<Group.GroupType> value)
protected Group	typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getMeta, getStructureFhirVersionEnum, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

identifier

protected List<Identifier> identifier

A unique business identifier for this group.

active

protected BooleanType active

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

type

protected Enumeration<Group.GroupType> type

Identifies the broad classification of the kind of resources the group includes.

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.

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.

characteristic

protected List<Group.GroupCharacteristicComponent> characteristic

Identifies the traits shared by members of the group.

member

protected List<Group.GroupMemberComponent> member

Identifies the resource instances that are members of the group.

SP_ACTUAL

public static final String SP_ACTUAL

Search parameter: actual

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

See Also:

Constant Field Values

ACTUAL

public static final TokenClientParam ACTUAL

Fluent Client search parameter constant for actual

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

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

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

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

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

SP_CHARACTERISTIC_VALUE

public static final String SP_CHARACTERISTIC_VALUE

Search parameter: characteristic-value

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

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:

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 TokenClientParam CODE

Fluent Client search parameter constant for code

Description: The kind of resources contained
Type: token
Path: Group.code

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 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 Include INCLUDE_MEMBER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Group:member".

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 TokenClientParam EXCLUDE

Fluent Client search parameter constant for exclude

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

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 TokenClientParam TYPE

Fluent Client search parameter constant for type

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

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 TokenClientParam VALUE

Fluent Client search parameter constant for value

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

SP_CHARACTERISTIC

public static final String SP_CHARACTERISTIC

Search parameter: characteristic

Description: Kind of characteristic
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: Kind of characteristic
Type: token
Path: Group.characteristic.code

Constructor Detail

Group

public Group()

Constructor

Group

public Group(Enumeration<Group.GroupType> type,
             BooleanType actual)

Constructor

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A unique business identifier for this group.)

setIdentifier

public Group setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Group addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

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

hasActiveElement

public boolean hasActiveElement()

hasActive

public boolean hasActive()

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.

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

hasTypeElement

public boolean hasTypeElement()

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

hasActualElement

public boolean hasActualElement()

hasActual

public boolean hasActual()

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.

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

hasNameElement

public boolean hasNameElement()

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

hasQuantityElement

public boolean hasQuantityElement()

hasQuantity

public boolean hasQuantity()

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.

getCharacteristic

public List<Group.GroupCharacteristicComponent> getCharacteristic()

Returns:

characteristic (Identifies the traits shared by members of the group.)

setCharacteristic

public Group setCharacteristic(List<Group.GroupCharacteristicComponent> theCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasCharacteristic

public boolean hasCharacteristic()

addCharacteristic

public Group.GroupCharacteristicComponent addCharacteristic()

addCharacteristic

public Group addCharacteristic(Group.GroupCharacteristicComponent t)

getCharacteristicFirstRep

public Group.GroupCharacteristicComponent getCharacteristicFirstRep()

Returns:

The first repetition of repeating field characteristic, creating it if it does not already exist

getMember

public List<Group.GroupMemberComponent> getMember()

Returns:

member (Identifies the resource instances that are members of the group.)

setMember

public Group setMember(List<Group.GroupMemberComponent> theMember)

Returns:

Returns a reference to this for easy method chaining

hasMember

public boolean hasMember()

addMember

public Group.GroupMemberComponent addMember()

addMember

public Group addMember(Group.GroupMemberComponent t)

getMemberFirstRep

public Group.GroupMemberComponent getMemberFirstRep()

Returns:

The first repetition of repeating field member, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException

Overrides:

getProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

FHIRException

addChild

public Base addChild(String name)
              throws FHIRException

Overrides:

addChild in class DomainResource

Throws:

FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class DomainResource

copy

public Group copy()

Specified by:

copy in class DomainResource

typedCopy

protected Group typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource