Data Model Libraries
    Preparing search index...

    EncounterHistoryLocationComponent Class

    FHIR Specification

    • Short: Location of the patient at this point in the encounter
    • Definition: The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.
    • Comment: Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    location: null | Reference

    EncounterHistory.location.location Element

    FHIR Specification

    • Short: Location the encounter takes place
    • Definition: The location where the encounter takes place.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    EncounterHistory.location.form Element

    FHIR Specification

    • Short: The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
    • Definition: This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
    • Comment: This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EncounterHistoryLocationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EncounterHistoryLocationComponent

      EncounterHistoryLocationComponent data model or undefined for EncounterHistoryLocationComponent

      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