Data Model Libraries
    Preparing search index...

    Class Encounter

    Encounter Class

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

    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. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.
    • FHIR Version: 5.0.0

    FHIR Encounter

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? encounterStatusEnum status class_? priority? type_? serviceType? subject? subjectStatus? episodeOfCare? basedOn? careTeam? partOf? serviceProvider? participant? appointment? virtualService? actualPeriod? plannedStartDate? plannedEndDate? length? reason? diagnosis? account? dietPreference? specialArrangement? specialCourtesy? admission? location?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getClass setClass addClass hasClass getPriority setPriority hasPriority getType setType addType hasType getServiceType setServiceType addServiceType hasServiceType getSubject setSubject hasSubject getSubjectStatus setSubjectStatus hasSubjectStatus getEpisodeOfCare setEpisodeOfCare addEpisodeOfCare hasEpisodeOfCare getBasedOn setBasedOn addBasedOn hasBasedOn getCareTeam setCareTeam addCareTeam hasCareTeam getPartOf setPartOf hasPartOf getServiceProvider setServiceProvider hasServiceProvider getParticipant setParticipant addParticipant hasParticipant getAppointment setAppointment addAppointment hasAppointment getVirtualService setVirtualService addVirtualService hasVirtualService getActualPeriod setActualPeriod hasActualPeriod getPlannedStartDateElement setPlannedStartDateElement hasPlannedStartDateElement getPlannedStartDate setPlannedStartDate hasPlannedStartDate getPlannedEndDateElement setPlannedEndDateElement hasPlannedEndDateElement getPlannedEndDate setPlannedEndDate hasPlannedEndDate getLength setLength hasLength getReason setReason addReason hasReason getDiagnosis setDiagnosis addDiagnosis hasDiagnosis getAccount setAccount addAccount hasAccount getDietPreference setDietPreference addDietPreference hasDietPreference getSpecialArrangement setSpecialArrangement addSpecialArrangement hasSpecialArrangement getSpecialCourtesy setSpecialCourtesy addSpecialCourtesy hasSpecialCourtesy getAdmission setAdmission hasAdmission 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 initClass initType initServiceType initEpisodeOfCare initBasedOn initCareTeam initParticipant initAppointment initVirtualService initReason initDiagnosis initAccount initDietPreference initSpecialArrangement initSpecialCourtesy 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 | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
    • Definition: The current state of the encounter (not the state of the patient within the encounter - that is subjectState).
    • 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

    Private Optionalclass_

    class_?: CodeableConcept[]

    Encounter.class Element

    FHIR Specification

    • Short: Classification of patient encounter context - e.g. Inpatient, outpatient
    • 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: 0..*
    • 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

    Private Optionaltype_

    type_?: CodeableConcept[]

    Encounter.type Element

    FHIR Specification

    • Short: Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
    • 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[]

    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: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: Reference

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

    Encounter.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.
    • Comment: Different use-cases are likely to have different permitted transitions between states, such as an Emergency department could use arrived when the patient first presents, then triaged once has been assessed by a nurse, then receiving-care once treatment begins, however other sectors may use a different set of these values, or their own custom set in place of this example valueset provided.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    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

    careTeam?: Reference[]

    Encounter.careTeam Element

    FHIR Specification

    • Short: The group(s) that are allocated to participate in this encounter
    • Definition: The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • 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
    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 colonoscopy example on the Encounter examples tab.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • 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.
    • Comment: Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.
    • 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
    virtualService?: VirtualServiceDetail[]

    Encounter.virtualService Element

    FHIR Specification

    • Short: Connection details of a virtual service (e.g. conference call)
    • Definition: Connection details of a virtual service (e.g. conference call).
    • Comment: There are two types of virtual meetings that often exist: * a persistent, virtual meeting room that can only be used for a single purpose at a time, * and a dynamic virtual meeting room that is generated on demand for a specific purpose. Implementers may consider using Location.virtualService for persistent meeting rooms. If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Encounter.participant BackboneElement.
    • FHIR Type: VirtualServiceDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    actualPeriod?: Period

    Encounter.actualPeriod Element

    FHIR Specification

    • Short: The actual start and end time of the encounter
    • Definition: The actual 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
    plannedStartDate?: DateTimeType

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

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

    Encounter.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
    reason?: EncounterReasonComponent[]

    Encounter.reason Element

    FHIR Specification

    • Short: The list of medical reasons that are expected to be addressed during the episode of care
    • Definition: The list of medical reasons that are expected to be addressed during the episode of care.
    • Comment: The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'. Examples: * pregnancy would use HealthcareService or a coding as the reason * patient home monitoring could use Condition as the reason
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    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.
    • Comment: Also note that for the purpose of billing, the diagnoses are recorded in the account where they can be ranked appropriately for how the invoicing/claiming documentation needs to be prepared.
    • 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
    dietPreference?: CodeableConcept[]

    Encounter.dietPreference Element

    FHIR Specification

    • Short: Diet preferences reported by the patient
    • Definition: Diet preferences reported by the patient.
    • Comment: For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).
    • Requirements: Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    specialArrangement?: CodeableConcept[]

    Encounter.specialArrangement Element

    FHIR Specification

    • Short: Wheelchair, translator, stretcher, etc
    • Definition: Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    specialCourtesy?: CodeableConcept[]

    Encounter.specialCourtesy Element

    FHIR Specification

    • Short: Special courtesies (VIP, board member)
    • Definition: Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).
    • Comment: Although the specialCourtesy property can contain values like VIP, the purpose of this field is intended to be used for flagging additional benefits that might occur for the patient during the encounter. It could include things like the patient is to have a private room, special room features, receive a friendly visit from hospital adminisitration, or should be briefed on treatment by senior staff during the stay. It is not specifically intended to be used for securing the specific record - that is the purpose of the security meta tag, and where appropriate, both fields could be used.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    admission?: EncounterAdmissionComponent

    Encounter.admission Element

    FHIR Specification

    • Short: Details about the admission to a healthcare service
    • Definition: Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.
    • 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 admission 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

    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 basedOn property.

      Parameters

      • value: undefined | Reference[]

        the basedOn array value

      Returns this

      this

      @ReferenceTargets('Encounter.basedOn', ['CarePlan','DeviceRequest','MedicationRequest','ServiceRequest',])

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetClasssetClassaddClasshasClassgetPrioritysetPriorityhasPrioritygetTypesetTypeaddTypehasTypegetServiceTypesetServiceTypeaddServiceTypehasServiceTypegetSubjectsetSubjecthasSubjectgetSubjectStatussetSubjectStatushasSubjectStatusgetEpisodeOfCaresetEpisodeOfCareaddEpisodeOfCarehasEpisodeOfCaregetBasedOnsetBasedOnaddBasedOnhasBasedOngetCareTeamsetCareTeamaddCareTeamhasCareTeamgetPartOfsetPartOfhasPartOfgetServiceProvidersetServiceProviderhasServiceProvidergetParticipantsetParticipantaddParticipanthasParticipantgetAppointmentsetAppointmentaddAppointmenthasAppointmentgetVirtualServicesetVirtualServiceaddVirtualServicehasVirtualServicegetActualPeriodsetActualPeriodhasActualPeriodgetPlannedStartDateElementsetPlannedStartDateElementhasPlannedStartDateElementgetPlannedStartDatesetPlannedStartDatehasPlannedStartDategetPlannedEndDateElementsetPlannedEndDateElementhasPlannedEndDateElementgetPlannedEndDatesetPlannedEndDatehasPlannedEndDategetLengthsetLengthhasLengthgetReasonsetReasonaddReasonhasReasongetDiagnosissetDiagnosisaddDiagnosishasDiagnosisgetAccountsetAccountaddAccounthasAccountgetDietPreferencesetDietPreferenceaddDietPreferencehasDietPreferencegetSpecialArrangementsetSpecialArrangementaddSpecialArrangementhasSpecialArrangementgetSpecialCourtesysetSpecialCourtesyaddSpecialCourtesyhasSpecialCourtesygetAdmissionsetAdmissionhasAdmissiongetLocationsetLocationaddLocationhasLocationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitClassinitTypeinitServiceTypeinitEpisodeOfCareinitBasedOninitCareTeaminitParticipantinitAppointmentinitVirtualServiceinitReasoninitDiagnosisinitAccountinitDietPreferenceinitSpecialArrangementinitSpecialCourtesyinitLocation