Data Model Libraries
    Preparing search index...

    Population Class

    Base StructureDefinition for Population Type: A populatioof people with some set of grouping criteria.

    FHIR Specification

    • Short: A definition of a set of people that apply to some clinically related context, for example people contraindicated for a certain medication
    • Definition: A populatioof people with some set of grouping criteria.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    age?: IDataType

    Population.age[x] Element

    @ChoiceDataTypesMeta('Population.age[x]', ['Range','CodeableConcept',]

    FHIR Specification

    • Short: The age of the specific population
    • Definition: The age of the specific population.
    • FHIR Types: 'Range', 'CodeableConcept',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Population.gender Element

    FHIR Specification

    • Short: The gender of the specific population
    • Definition: The gender of the specific population.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Population.race Element

    FHIR Specification

    • Short: Race of the specific population
    • Definition: Race of the specific population.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    physiologicalCondition?: CodeableConcept

    Population.physiologicalCondition Element

    FHIR Specification

    • Short: The existing physiological conditions of the specific population to which this applies
    • Definition: The existing physiological conditions of the specific population to which this applies.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Population

      • OptionaloptSourceField: string

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

      Returns undefined | Population

      Population data model or undefined for Population

      JsonError if the provided JSON is not a valid JSON object

    • Determines if modifierExtension property exists for the provided url

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if the modifierExtension property exists and has at least one element; false otherwise

    • Adds the provided Extension to the modifierExtension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the modifierExtension property array

      Returns this

      this

    • Removes the Extension having the provided url from the modifierExtension 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

    • 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

    • 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

    • 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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

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