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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGroup.GroupCharacteristicComponentstatic classGroup.GroupMemberComponentstatic classGroup.GroupTypestatic classGroup.GroupTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypeactiveIndicates whether the record for the group is available for use or is merely being retained for historical purposes.protected BooleanTypeactualIf true, indicates that the resource refers to a specific group of real individuals.static ca.uhn.fhir.rest.gclient.TokenClientParamACTUALFluent Client search parameter constant for actualprotected List<Group.GroupCharacteristicComponent>characteristicIdentifies traits whose presence r absence is shared by members of the group.static ca.uhn.fhir.rest.gclient.TokenClientParamCHARACTERISTICFluent Client search parameter constant for characteristicstatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CHARACTERISTIC_VALUEFluent Client search parameter constant for characteristic-valueprotected CodeableConceptcodeProvides a specific type of resource the group includes; e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codestatic ca.uhn.fhir.rest.gclient.TokenClientParamEXCLUDEFluent Client search parameter constant for excludeprotected List<Identifier>identifierA unique business identifier for this group.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_MANAGING_ENTITYConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MEMBERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMANAGING_ENTITYFluent Client search parameter constant for managing-entityprotected ReferencemanagingEntityEntity responsible for defining and maintaining Group characteristics and/or registered members.protected ResourcemanagingEntityTargetThe actual object that is the target of the reference (Entity responsible for defining and maintaining Group characteristics and/or registered members.)protected List<Group.GroupMemberComponent>memberIdentifies the resource instances that are members of the group.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMEMBERFluent Client search parameter constant for memberprotected StringTypenameA label assigned to the group for human identification and communication.protected UnsignedIntTypequantityA count of the number of resource instances that are part of the group.static StringSP_ACTUALSearch parameter: actualstatic StringSP_CHARACTERISTICSearch parameter: characteristicstatic StringSP_CHARACTERISTIC_VALUESearch parameter: characteristic-valuestatic StringSP_CODESearch parameter: codestatic StringSP_EXCLUDESearch parameter: excludestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_MANAGING_ENTITYSearch parameter: managing-entitystatic StringSP_MEMBERSearch parameter: memberstatic StringSP_TYPESearch parameter: typestatic StringSP_VALUESearch parameter: valueprotected Enumeration<Group.GroupType>typeIdentifies the broad classification of the kind of resources the group includes.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.TokenClientParamVALUEFluent Client search parameter constant for value-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Group()ConstructorGroup(Enumeration<Group.GroupType> type, BooleanType actual)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
-
-
-
-
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.
-
managingEntity
protected Reference managingEntity
Entity responsible for defining and maintaining Group characteristics and/or registered members.
-
managingEntityTarget
protected Resource managingEntityTarget
The actual object that is the target of the reference (Entity responsible for defining and maintaining Group characteristics and/or registered members.)
-
characteristic
protected List<Group.GroupCharacteristicComponent> characteristic
Identifies traits whose presence r absence is 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: actualDescription: Descriptive or actual
Type: token
Path: Group.actual
- See Also:
- Constant Field Values
-
ACTUAL
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTUAL
Fluent Client search parameter constant for actualDescription: Descriptive or actual
Type: token
Path: Group.actual
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Unique id
Type: token
Path: Group.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Unique id
Type: token
Path: Group.identifier
-
SP_CHARACTERISTIC_VALUE
public static final String SP_CHARACTERISTIC_VALUE
Search parameter: characteristic-valueDescription: A composite of both characteristic and value
Type: composite
Path:
- See Also:
- Constant Field Values
-
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-valueDescription: A composite of both characteristic and value
Type: composite
Path:
-
SP_MANAGING_ENTITY
public static final String SP_MANAGING_ENTITY
Search parameter: managing-entityDescription: Entity that is the custodian of the Group's definition
Type: reference
Path: Group.managingEntity
- See Also:
- Constant Field Values
-
MANAGING_ENTITY
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANAGING_ENTITY
Fluent Client search parameter constant for managing-entityDescription: Entity that is the custodian of the Group's definition
Type: reference
Path: Group.managingEntity
-
INCLUDE_MANAGING_ENTITY
public static final ca.uhn.fhir.model.api.Include INCLUDE_MANAGING_ENTITY
Constant for fluent queries to be used to add include statements. Specifies the path value of "Group:managing-entity".
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: 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 codeDescription: The kind of resources contained
Type: token
Path: Group.code
-
SP_MEMBER
public static final String SP_MEMBER
Search parameter: memberDescription: 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 memberDescription: 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".
-
SP_EXCLUDE
public static final String SP_EXCLUDE
Search parameter: excludeDescription: 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 excludeDescription: Group includes or excludes
Type: token
Path: Group.characteristic.exclude
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: 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 typeDescription: The type of resources the group contains
Type: token
Path: Group.type
-
SP_VALUE
public static final String SP_VALUE
Search parameter: valueDescription: 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 valueDescription: Value held by characteristic
Type: token
Path: Group.characteristic.value[x]
-
SP_CHARACTERISTIC
public static final String SP_CHARACTERISTIC
Search parameter: characteristicDescription: Kind of characteristic
Type: token
Path: Group.characteristic.code
- See Also:
- Constant Field Values
-
CHARACTERISTIC
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CHARACTERISTIC
Fluent Client search parameter constant for characteristicDescription: 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
thisfor 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.
-
getManagingEntity
public Reference getManagingEntity()
- Returns:
managingEntity(Entity responsible for defining and maintaining Group characteristics and/or registered members.)
-
hasManagingEntity
public boolean hasManagingEntity()
-
setManagingEntity
public Group setManagingEntity(Reference value)
- Parameters:
value-managingEntity(Entity responsible for defining and maintaining Group characteristics and/or registered members.)
-
getManagingEntityTarget
public Resource getManagingEntityTarget()
- Returns:
managingEntityThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Entity responsible for defining and maintaining Group characteristics and/or registered members.)
-
setManagingEntityTarget
public Group setManagingEntityTarget(Resource value)
- Parameters:
value-managingEntityThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Entity responsible for defining and maintaining Group characteristics and/or registered members.)
-
getCharacteristic
public List<Group.GroupCharacteristicComponent> getCharacteristic()
- Returns:
characteristic(Identifies traits whose presence r absence is shared by members of the group.)
-
setCharacteristic
public Group setCharacteristic(List<Group.GroupCharacteristicComponent> theCharacteristic)
- Returns:
- Returns a reference to
thisfor 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
thisfor 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> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Group copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Group dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-