Data Model Libraries
    Preparing search index...

    EncounterStatusHistoryComponent Class

    FHIR Specification

    • Short: List of past encounter statuses
    • Definition: The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
    • Comment: The current status is always found in the current version of the resource, not the status history.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    encounterStatusEnum: EncounterStatusEnum

    FHIR CodeSystem: EncounterStatus

    status: null | EnumCodeType

    Encounter.statusHistory.status Element

    FHIR Specification

    • Short: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    • Definition: planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: EncounterStatusEnum

    period: null | Period

    Encounter.statusHistory.period Element

    FHIR Specification

    • Short: The time that the episode was in the specified status
    • Definition: The time that the episode was in the specified status.
    • FHIR Type: Period
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EncounterStatusHistoryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EncounterStatusHistoryComponent

      EncounterStatusHistoryComponent data model or undefined for EncounterStatusHistoryComponent

      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