Data Model Libraries
    Preparing search index...

    Class Group

    Group Class

    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.

    FHIR Specification

    • Short: 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.
    • Comment: If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.
    • FHIR Version: 4.3.0

    FHIR Group

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? groupTypeEnum type_ actual code? name? quantity? managingEntity? characteristic? member?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getActualElement setActualElement hasActualElement getActual setActual hasActual getCode setCode hasCode getNameElement setNameElement hasNameElement getName setName hasName getQuantityElement setQuantityElement hasQuantityElement getQuantity setQuantity hasQuantity getManagingEntity setManagingEntity hasManagingEntity getCharacteristic setCharacteristic addCharacteristic hasCharacteristic getMember setMember addMember hasMember fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCharacteristic initMember

    Constructors

    Properties

    identifier?: Identifier[]

    Group.identifier Element

    FHIR Specification

    • Short: Unique id
    • Definition: A unique business identifier for this group.
    • Requirements: Allows the group to be referenced from external specifications.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    Group.active Element

    FHIR Specification

    • Short: Whether this group's record is in active use
    • Definition: Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
    • Requirements: Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    groupTypeEnum: GroupTypeEnum

    FHIR CodeSystem: GroupType

    GroupTypeEnum

    Privatetype_

    type_: null | EnumCodeType

    Group.type Element

    FHIR Specification

    • Short: person | animal | practitioner | device | medication | substance
    • Definition: Identifies the broad classification of the kind of resources the group includes.
    • Comment: Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).
    • Requirements: Identifies what type of resources the group is made up of.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: GroupTypeEnum

    actual: null | BooleanType

    Group.actual Element

    FHIR Specification

    • Short: 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.
    • Requirements: There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept

    Group.code Element

    FHIR Specification

    • Short: Kind of Group members
    • Definition: Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
    • Comment: This would generally be omitted for Person resources.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    Group.name Element

    FHIR Specification

    • Short: Label for Group
    • Definition: A label assigned to the group for human identification and communication.
    • Requirements: Used to identify the group in human communication.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    quantity?: UnsignedIntType

    Group.quantity Element

    FHIR Specification

    • Short: Number of members
    • Definition: A count of the number of resource instances that are part of the group.
    • Comment: Note that the quantity may be less than the number of members if some of the members are not active.
    • Requirements: Group size is a common defining characteristic.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    managingEntity?: Reference

    Group.managingEntity Element

    FHIR Specification

    characteristic?: GroupCharacteristicComponent[]

    Group.characteristic Element

    FHIR Specification

    • Short: Include / Exclude group members by Trait
    • Definition: Identifies traits whose presence r absence is shared by members of the group.
    • Comment: All the identified characteristics must be true for an entity to a member of the group.
    • Requirements: Needs to be a generic mechanism for identifying what individuals can be part of a group.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    member?: GroupMemberComponent[]

    Group.member Element

    FHIR Specification

    • Short: Who or what is in group
    • Definition: Identifies the resource instances that are members of the group.
    • Requirements: Often the only thing of interest about a group is "who's in it".
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Group JSON to instantiate the Group data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Group

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Group

      Returns undefined | Group

      Group data model or undefined for Group

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided ManagingEntity object value to the managingEntity property.

      Parameters

      • value: undefined | Reference

        the managingEntity object value

      Returns this

      this

      @ReferenceTargets('Group.managingEntity', ['Organization','RelatedPerson','Practitioner','PractitionerRole',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetActualElementsetActualElementhasActualElementgetActualsetActualhasActualgetCodesetCodehasCodegetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetQuantityElementsetQuantityElementhasQuantityElementgetQuantitysetQuantityhasQuantitygetManagingEntitysetManagingEntityhasManagingEntitygetCharacteristicsetCharacteristicaddCharacteristichasCharacteristicgetMembersetMemberaddMemberhasMemberfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCharacteristicinitMember