Data Model Libraries
    Preparing search index...

    Class EncounterHistory

    EncounterHistory Class

    A record of significant events/milestones key data throughout the history of an Encounter

    FHIR Specification

    • Short: A record of significant events/milestones key data throughout the history of an Encounter
    • Definition: A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.
    • FHIR Version: 5.0.0

    FHIR EncounterHistory

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    encounter? identifier? encounterStatusEnum status class_ type_? serviceType? subject? subjectStatus? actualPeriod? plannedStartDate? plannedEndDate? length? location?

    Methods

    parse getEncounter setEncounter hasEncounter getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getClass setClass hasClass getType setType addType hasType getServiceType setServiceType addServiceType hasServiceType getSubject setSubject hasSubject getSubjectStatus setSubjectStatus hasSubjectStatus getActualPeriod setActualPeriod hasActualPeriod getPlannedStartDateElement setPlannedStartDateElement hasPlannedStartDateElement getPlannedStartDate setPlannedStartDate hasPlannedStartDate getPlannedEndDateElement setPlannedEndDateElement hasPlannedEndDateElement getPlannedEndDate setPlannedEndDate hasPlannedEndDate getLength setLength hasLength getLocation setLocation addLocation hasLocation fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initType initServiceType initLocation

    Constructors

    Properties

    encounter?: Reference

    EncounterHistory.encounter Element

    FHIR Specification

    • Short: The Encounter associated with this set of historic values
    • Definition: The Encounter associated with this set of historic values.
    • Comment: This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    identifier?: Identifier[]

    EncounterHistory.identifier Element

    FHIR Specification

    • Short: Identifier(s) by which this encounter is known
    • Definition: Identifier(s) by which this encounter is known.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    encounterStatusEnum: EncounterStatusEnum

    FHIR CodeSystem: EncounterStatus

    EncounterStatusEnum

    status: null | EnumCodeType

    EncounterHistory.status Element

    FHIR Specification

    • Short: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
    • Definition: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.
    • Comment: Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: EncounterStatusEnum

    Privateclass_

    class_: null | CodeableConcept

    EncounterHistory.class Element

    FHIR Specification

    • Short: Classification of patient encounter
    • Definition: Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept[]

    EncounterHistory.type Element

    FHIR Specification

    • Short: Specific type of encounter
    • Definition: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
    • Comment: Since there are many ways to further classify encounters, this element is 0..*.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    serviceType?: CodeableReference[]

    EncounterHistory.serviceType Element

    FHIR Specification

    • Short: Specific type of service
    • Definition: Broad categorization of the service that is to be provided (e.g. cardiology).
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: Reference

    EncounterHistory.subject Element

    FHIR Specification

    • Short: The patient or group related to this encounter
    • Definition: The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.
    • Comment: While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subjectStatus?: CodeableConcept

    EncounterHistory.subjectStatus Element

    FHIR Specification

    • Short: The current status of the subject in relation to the Encounter
    • Definition: The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    actualPeriod?: Period

    EncounterHistory.actualPeriod Element

    FHIR Specification

    • Short: The actual start and end time associated with this set of values associated with the encounter
    • Definition: The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    plannedStartDate?: DateTimeType

    EncounterHistory.plannedStartDate Element

    FHIR Specification

    • Short: The planned start date/time (or admission date) of the encounter
    • Definition: The planned start date/time (or admission date) of the encounter.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    plannedEndDate?: DateTimeType

    EncounterHistory.plannedEndDate Element

    FHIR Specification

    • Short: The planned end date/time (or discharge date) of the encounter
    • Definition: The planned end date/time (or discharge date) of the encounter.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    length?: Duration

    EncounterHistory.length Element

    FHIR Specification

    • Short: Actual quantity of time the encounter lasted (less time absent)
    • Definition: Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.
    • Comment: If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval. May differ from the time in Encounter.period due to leave of absence(s).
    • FHIR Type: Duration
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    location?: EncounterHistoryLocationComponent[]

    EncounterHistory.location Element

    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".
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EncounterHistory

      • OptionaloptSourceField: string

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

      Returns undefined | EncounterHistory

      EncounterHistory data model or undefined for EncounterHistory

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetEncountersetEncounterhasEncountergetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetClasssetClasshasClassgetTypesetTypeaddTypehasTypegetServiceTypesetServiceTypeaddServiceTypehasServiceTypegetSubjectsetSubjecthasSubjectgetSubjectStatussetSubjectStatushasSubjectStatusgetActualPeriodsetActualPeriodhasActualPeriodgetPlannedStartDateElementsetPlannedStartDateElementhasPlannedStartDateElementgetPlannedStartDatesetPlannedStartDatehasPlannedStartDategetPlannedEndDateElementsetPlannedEndDateElementhasPlannedEndDateElementgetPlannedEndDatesetPlannedEndDatehasPlannedEndDategetLengthsetLengthhasLengthgetLocationsetLocationaddLocationhasLocationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitTypeinitServiceTypeinitLocation