Package org.hl7.fhir.r5.model

Class Group

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.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:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.

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

    • membership

      protected Enumeration<Group.GroupMembershipBasis> membership
      Basis for membership in the Group: 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.

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

    • description

      protected MarkdownType description
      Explanation of what the group represents and how it is intended to be used.

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

    • 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_CHARACTERISTIC_REFERENCE

      public static final String SP_CHARACTERISTIC_REFERENCE
      Search parameter: characteristic-reference

      Description: An entity referenced in a characteristic
      Type: reference
      Path: (Group.characteristic.value.ofType(Reference))

      See Also:

    • CHARACTERISTIC_REFERENCE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CHARACTERISTIC_REFERENCE
      Fluent Client search parameter constant for characteristic-reference

      Description: An entity referenced in a characteristic
      Type: reference
      Path: (Group.characteristic.value.ofType(Reference))

    • INCLUDE_CHARACTERISTIC_REFERENCE

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

    • 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: Group.characteristic

      See Also:

    • 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: Group.characteristic

    • SP_CHARACTERISTIC

      public static final String SP_CHARACTERISTIC
      Search parameter: characteristic

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

      See Also:

    • 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_CODE

      public static final String SP_CODE
      Search parameter: code

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

      See Also:

    • 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

    • SP_EXCLUDE

      public static final String SP_EXCLUDE
      Search parameter: exclude

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

      See Also:

    • 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_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:

    • 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

    • SP_MANAGING_ENTITY

      public static final String SP_MANAGING_ENTITY
      Search parameter: managing-entity

      Description: Entity that is the custodian of the Group's definition
      Type: reference
      Path: Group.managingEntity

      See Also:

    • MANAGING_ENTITY

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANAGING_ENTITY
      Fluent Client search parameter constant for managing-entity

      Description: 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_MEMBER

      public static final String SP_MEMBER
      Search parameter: member

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

      See Also:

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

    • SP_MEMBERSHIP

      public static final String SP_MEMBERSHIP
      Search parameter: membership

      Description: Definitional or enumerated group
      Type: token
      Path: Group.membership

      See Also:

    • MEMBERSHIP

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

      Description: Definitional or enumerated group
      Type: token
      Path: Group.membership

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: A portion of the Group's name
      Type: string
      Path: Group.name

      See Also:

    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: A portion of the Group's name
      Type: string
      Path: Group.name

    • 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:

    • 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

    • SP_VALUE

      public static final String SP_VALUE
      Search parameter: value

      Description: Value held by characteristic
      Type: token
      Path: (Group.characteristic.value.ofType(CodeableConcept)) | (Group.characteristic.value.ofType(boolean))

      See Also:

    • 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.ofType(CodeableConcept)) | (Group.characteristic.value.ofType(boolean))

  • Constructor Details

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      identifier (Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.)

    • 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 {3}

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

    • getMembershipElement

      public Enumeration<Group.GroupMembershipBasis> getMembershipElement()
      Returns:
      membership (Basis for membership in the Group: 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.). This is the underlying object with id, value and extensions. The accessor "getMembership" gives direct access to the value

    • hasMembershipElement

      public boolean hasMembershipElement()

    • hasMembership

      public boolean hasMembership()

    • setMembershipElement

      public Group setMembershipElement(Enumeration<Group.GroupMembershipBasis> value)
      Parameters:
      value - membership (Basis for membership in the Group: 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.). This is the underlying object with id, value and extensions. The accessor "getMembership" gives direct access to the value

    • getMembership

      public Group.GroupMembershipBasis getMembership()
      Returns:
      Basis for membership in the Group: 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.

    • setMembership

      public Group setMembership(Group.GroupMembershipBasis value)
      Parameters:
      value - Basis for membership in the Group: 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.

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

    • getDescriptionElement

      public MarkdownType getDescriptionElement()
      Returns:
      description (Explanation of what the group represents and how it is intended to be used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • setDescriptionElement

      public Group setDescriptionElement(MarkdownType value)
      Parameters:
      value - description (Explanation of what the group represents and how it is intended to be used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • getDescription

      public String getDescription()
      Returns:
      Explanation of what the group represents and how it is intended to be used.

    • setDescription

      public Group setDescription(String value)
      Parameters:
      value - Explanation of what the group represents and how it is intended to be used.

    • 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.)

    • 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 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 {3}

    • 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 {3}

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • 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

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public Group copy()
      Specified by:
      copy in class DomainResource

    • copyValues

      public void copyValues(Group dst)

    • 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 org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource