Data Model Libraries
    Preparing search index...

    EncounterLocationComponent Class

    FHIR Specification

    • Short: List of locations where the patient has been
    • Definition: List of locations where the patient has been during this encounter.
    • 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

    Encounter.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
    encounterLocationStatusEnum: EncounterLocationStatusEnum

    FHIR CodeSystem: EncounterLocationStatus

    status?: EnumCodeType

    Encounter.location.status Element

    FHIR Specification

    • Short: planned | active | reserved | completed
    • Definition: The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
    • Comment: When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: EncounterLocationStatusEnum

    Encounter.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
    period?: Period

    Encounter.location.period Element

    FHIR Specification

    • Short: Time period during which the patient was present at the location
    • Definition: Time period during which the patient was present at the location.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EncounterLocationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EncounterLocationComponent

      EncounterLocationComponent data model or undefined for EncounterLocationComponent

      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