Data Model Libraries
    Preparing search index...

    ListEntryComponent Class

    FHIR Specification

    • Short: Entries in the list
    • Definition: Entries in this list.
    • Comment: If there are no entries in the list, an emptyReason SHOULD be provided.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    List.entry.flag Element

    FHIR Specification

    • Short: Status/Workflow information about this item
    • Definition: The flag allows the system constructing the list to indicate the role and significance of the item in the list.
    • Comment: The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true
    • Requirements: This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    deleted?: BooleanType

    List.entry.deleted Element

    FHIR Specification

    • Short: If this item is actually marked as deleted
    • Definition: True if this item is marked as deleted in the list.
    • Comment: If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.
    • Requirements: The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted".
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: If deleted is true, then the item included in the list isn't actually part of the list anymore
    • isSummary: false

    List.entry.date Element

    FHIR Specification

    • Short: When item added to list
    • Definition: When this item was added to the list.
    • Requirements: The date may be significant for understanding the meaning of items in a working list.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    item: null | Reference

    List.entry.item Element

    FHIR Specification

    • Short: Actual entry
    • Definition: A reference to the actual resource from which data was derived.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ListEntryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ListEntryComponent

      ListEntryComponent data model or undefined for ListEntryComponent

      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