Class Group

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:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Group extends BaseResource implements ca.uhn.fhir.model.api.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
  • Field Details

    • 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 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_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 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_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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 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: characteristic & value

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

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • 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

      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

      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 ca.uhn.fhir.model.primitive.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. This method may return null.

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

    • setType

      public Group setType(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may 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(ca.uhn.fhir.model.primitive.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

      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 ca.uhn.fhir.model.primitive.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. This method may return null.

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

    • setName

      public Group setName(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may return null.

      Definition: A count of the number of resource instances that are part of the group

    • setQuantity

      public Group setQuantity(ca.uhn.fhir.model.primitive.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

      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

      Sets the value(s) for characteristic ()

      Definition: Identifies the traits shared by members of the group

    • addCharacteristic

      Adds and returns a new value for characteristic ()

      Definition: Identifies the traits shared by members of the group

    • addCharacteristic

      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

      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

      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

      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

      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

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource