Data Model Libraries
    Preparing search index...

    GroupCharacteristicComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeableConcept

    Group.characteristic.code Element

    FHIR Specification

    • Short: Kind of characteristic
    • Definition: A code that identifies the kind of trait being asserted.
    • Requirements: Need a formal way of identifying the characteristic being described.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    value: null | IDataType

    Group.characteristic.value[x] Element

    @ChoiceDataTypesMeta('Group.characteristic.value[x]', ['CodeableConcept','boolean','Quantity','Range','Reference',]

    FHIR Specification

    • Short: Value held by characteristic
    • Definition: The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
    • Comment: For Range, it means members of the group have a value that falls somewhere within the specified range.
    • Requirements: The value of the characteristic is what determines group membership.
    • FHIR Types: 'CodeableConcept', 'boolean', 'Quantity', 'Range', 'Reference',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    exclude: null | BooleanType

    Group.characteristic.exclude Element

    FHIR Specification

    • Short: Group includes or excludes
    • Definition: If true, indicates the characteristic is one that is NOT held by members of the group.
    • Comment: This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.
    • Requirements: Sometimes group membership is determined by characteristics not possessed.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    period?: Period

    Group.characteristic.period Element

    FHIR Specification

    • Short: Period over which characteristic is tested
    • Definition: The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR GroupCharacteristicComponent

      • OptionaloptSourceField: string

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

      Returns undefined | GroupCharacteristicComponent

      GroupCharacteristicComponent data model or undefined for GroupCharacteristicComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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