Data Model Libraries
    Preparing search index...

    Class Encounter

    Encounter Class

    An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

    FHIR Specification

    • Short: An interaction during which services are provided to the patient
    • Definition: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
    • FHIR Version: 4.3.0

    FHIR Encounter

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? encounterStatusEnum status statusHistory? class_ classHistory? type_? serviceType? priority? subject? episodeOfCare? basedOn? participant? appointment? period? length? reasonCode? reasonReference? diagnosis? account? hospitalization? location? serviceProvider? partOf?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusHistory setStatusHistory addStatusHistory hasStatusHistory getClass setClass hasClass getClassHistory setClassHistory addClassHistory hasClassHistory getType setType addType hasType getServiceType setServiceType hasServiceType getPriority setPriority hasPriority getSubject setSubject hasSubject getEpisodeOfCare setEpisodeOfCare addEpisodeOfCare hasEpisodeOfCare getBasedOn setBasedOn addBasedOn hasBasedOn getParticipant setParticipant addParticipant hasParticipant getAppointment setAppointment addAppointment hasAppointment getPeriod setPeriod hasPeriod getLength setLength hasLength getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getDiagnosis setDiagnosis addDiagnosis hasDiagnosis getAccount setAccount addAccount hasAccount getHospitalization setHospitalization hasHospitalization getLocation setLocation addLocation hasLocation getServiceProvider setServiceProvider hasServiceProvider getPartOf setPartOf hasPartOf 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 initStatusHistory initClassHistory initType initEpisodeOfCare initBasedOn initParticipant initAppointment initReasonCode initReasonReference initDiagnosis initAccount initLocation

    Constructors

    Properties

    identifier?: Identifier[]

    Encounter.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

    Encounter.status Element

    FHIR Specification

    • Short: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    • Definition: planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
    • 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

    statusHistory?: EncounterStatusHistoryComponent[]

    Encounter.statusHistory Element

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

    Privateclass_

    class_: null | Coding

    Encounter.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: Coding
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    classHistory?: EncounterClassHistoryComponent[]

    Encounter.classHistory Element

    FHIR Specification

    • Short: List of past encounter classes
    • Definition: The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Private Optionaltype_

    type_?: CodeableConcept[]

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

    Encounter.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: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    priority?: CodeableConcept

    Encounter.priority Element

    FHIR Specification

    • Short: Indicates the urgency of the encounter
    • Definition: Indicates the urgency of the encounter.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    subject?: Reference

    Encounter.subject Element

    FHIR Specification

    • Short: The patient or group present at the encounter
    • Definition: The patient or group present at the encounter.
    • 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
    episodeOfCare?: Reference[]

    Encounter.episodeOfCare Element

    FHIR Specification

    • Short: Episode(s) of care that this encounter should be recorded against
    • Definition: Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    Encounter.basedOn Element

    FHIR Specification

    • Short: The ServiceRequest that initiated this encounter
    • Definition: The request this encounter satisfies (e.g. incoming referral or procedure request).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    participant?: EncounterParticipantComponent[]

    Encounter.participant Element

    FHIR Specification

    • Short: List of participants involved in the encounter
    • Definition: The list of people responsible for providing the service.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    appointment?: Reference[]

    Encounter.appointment Element

    FHIR Specification

    • Short: The appointment that scheduled this encounter
    • Definition: The appointment that scheduled this encounter.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    period?: Period

    Encounter.period Element

    FHIR Specification

    • Short: The start and end time of the encounter
    • Definition: The start and end time of the encounter.
    • Comment: If not (yet) known, the end of the Period may be omitted.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    length?: Duration

    Encounter.length Element

    FHIR Specification

    • Short: Quantity of time the encounter lasted (less time absent)
    • Definition: Quantity of time the encounter lasted. This excludes the time during leaves of absence.
    • Comment: May differ from the time the Encounter.period lasted because of leave of absence.
    • FHIR Type: Duration
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reasonCode?: CodeableConcept[]

    Encounter.reasonCode Element

    FHIR Specification

    • Short: Coded reason the encounter takes place
    • Definition: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
    • Comment: For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reasonReference?: Reference[]

    Encounter.reasonReference Element

    FHIR Specification

    diagnosis?: EncounterDiagnosisComponent[]

    Encounter.diagnosis Element

    FHIR Specification

    • Short: The list of diagnosis relevant to this encounter
    • Definition: The list of diagnosis relevant to this encounter.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    account?: Reference[]

    Encounter.account Element

    FHIR Specification

    • Short: The set of accounts that may be used for billing for this Encounter
    • Definition: The set of accounts that may be used for billing for this Encounter.
    • Comment: The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    hospitalization?: EncounterHospitalizationComponent

    Encounter.hospitalization Element

    FHIR Specification

    • Short: Details about the admission to a healthcare service
    • Definition: Details about the admission to a healthcare service.
    • Comment: An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    location?: EncounterLocationComponent[]

    Encounter.location Element

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

    Encounter.serviceProvider Element

    FHIR Specification

    • Short: The organization (facility) responsible for this encounter
    • Definition: The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    partOf?: Reference

    Encounter.partOf Element

    FHIR Specification

    • Short: Another Encounter this encounter is part of
    • Definition: Another Encounter of which this encounter is a part of (administratively or in time).
    • 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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Encounter

      • OptionaloptSourceField: string

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

      Returns undefined | Encounter

      Encounter data model or undefined for Encounter

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the reasonReference property.

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('Encounter.reasonReference', ['Condition','Procedure','Observation','ImmunizationRecommendation',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the reasonReference array property.

      Parameters

      • value: undefined | Reference

        the reasonReference value

      Returns this

      this

      @ReferenceTargets('Encounter.reasonReference', ['Condition','Procedure','Observation','ImmunizationRecommendation',])

      InvalidTypeError for invalid data type or reference value

    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusHistorysetStatusHistoryaddStatusHistoryhasStatusHistorygetClasssetClasshasClassgetClassHistorysetClassHistoryaddClassHistoryhasClassHistorygetTypesetTypeaddTypehasTypegetServiceTypesetServiceTypehasServiceTypegetPrioritysetPriorityhasPrioritygetSubjectsetSubjecthasSubjectgetEpisodeOfCaresetEpisodeOfCareaddEpisodeOfCarehasEpisodeOfCaregetBasedOnsetBasedOnaddBasedOnhasBasedOngetParticipantsetParticipantaddParticipanthasParticipantgetAppointmentsetAppointmentaddAppointmenthasAppointmentgetPeriodsetPeriodhasPeriodgetLengthsetLengthhasLengthgetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetDiagnosissetDiagnosisaddDiagnosishasDiagnosisgetAccountsetAccountaddAccounthasAccountgetHospitalizationsetHospitalizationhasHospitalizationgetLocationsetLocationaddLocationhasLocationgetServiceProvidersetServiceProviderhasServiceProvidergetPartOfsetPartOfhasPartOffhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitStatusHistoryinitClassHistoryinitTypeinitEpisodeOfCareinitBasedOninitParticipantinitAppointmentinitReasonCodeinitReasonReferenceinitDiagnosisinitAccountinitLocation