Data Model Libraries
    Preparing search index...

    GroupMemberComponent Class

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    entity: null | Reference

    Group.member.entity Element

    FHIR Specification

    period?: Period

    Group.member.period Element

    FHIR Specification

    • Short: Period member belonged to the group
    • Definition: The period that the member was in the group, if known.
    • Requirements: Need to track who was in a group at a particular time.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    inactive?: BooleanType

    Group.member.inactive Element

    FHIR Specification

    • Short: If member is no longer in group
    • Definition: A flag to indicate that the member is no longer in the group, but previously may have been a member.
    • Requirements: Sometimes you don't know when someone stopped being in a group, but not when.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR GroupMemberComponent

      • OptionaloptSourceField: string

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

      Returns undefined | GroupMemberComponent

      GroupMemberComponent data model or undefined for GroupMemberComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Entity object value to the entity property.

      Parameters

      • value: undefined | null | Reference

        the entity object value

      Returns this

      this

      @ReferenceTargets('Group.member.entity', ['Patient','Practitioner','PractitionerRole','Device','Medication','Substance','Group',])

      InvalidTypeError for invalid data type or reference value

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

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