Data Model Libraries
    Preparing search index...

    Class EncounterHospitalizationComponent

    EncounterHospitalizationComponent Class

    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 Encounter

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    preAdmissionIdentifier? origin? admitSource? reAdmission? dietPreference? specialCourtesy? specialArrangement? destination? dischargeDisposition?

    Methods

    parse getPreAdmissionIdentifier setPreAdmissionIdentifier hasPreAdmissionIdentifier getOrigin setOrigin hasOrigin getAdmitSource setAdmitSource hasAdmitSource getReAdmission setReAdmission hasReAdmission getDietPreference setDietPreference addDietPreference hasDietPreference getSpecialCourtesy setSpecialCourtesy addSpecialCourtesy hasSpecialCourtesy getSpecialArrangement setSpecialArrangement addSpecialArrangement hasSpecialArrangement getDestination setDestination hasDestination getDischargeDisposition setDischargeDisposition hasDischargeDisposition fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initDietPreference initSpecialCourtesy initSpecialArrangement

    Constructors

    Properties

    preAdmissionIdentifier?: Identifier

    Encounter.hospitalization.preAdmissionIdentifier Element

    FHIR Specification

    • Short: Pre-admission identifier
    • Definition: Pre-admission identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    origin?: Reference

    Encounter.hospitalization.origin Element

    FHIR Specification

    admitSource?: CodeableConcept

    Encounter.hospitalization.admitSource Element

    FHIR Specification

    • Short: From where patient was admitted (physician referral, transfer)
    • Definition: From where patient was admitted (physician referral, transfer).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reAdmission?: CodeableConcept

    Encounter.hospitalization.reAdmission Element

    FHIR Specification

    • Short: The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
    • Definition: Whether this hospitalization is a readmission and why if known.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dietPreference?: CodeableConcept[]

    Encounter.hospitalization.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
    specialCourtesy?: CodeableConcept[]

    Encounter.hospitalization.specialCourtesy Element

    FHIR Specification

    • Short: Special courtesies (VIP, board member)
    • Definition: Special courtesies (VIP, board member).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    specialArrangement?: CodeableConcept[]

    Encounter.hospitalization.specialArrangement Element

    FHIR Specification

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

    Encounter.hospitalization.destination Element

    FHIR Specification

    dischargeDisposition?: CodeableConcept

    Encounter.hospitalization.dischargeDisposition Element

    FHIR Specification

    • Short: Category or kind of location after discharge
    • Definition: Category or kind of location after discharge.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EncounterHospitalizationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EncounterHospitalizationComponent

      EncounterHospitalizationComponent data model or undefined for EncounterHospitalizationComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; 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
    parsegetPreAdmissionIdentifiersetPreAdmissionIdentifierhasPreAdmissionIdentifiergetOriginsetOriginhasOrigingetAdmitSourcesetAdmitSourcehasAdmitSourcegetReAdmissionsetReAdmissionhasReAdmissiongetDietPreferencesetDietPreferenceaddDietPreferencehasDietPreferencegetSpecialCourtesysetSpecialCourtesyaddSpecialCourtesyhasSpecialCourtesygetSpecialArrangementsetSpecialArrangementaddSpecialArrangementhasSpecialArrangementgetDestinationsetDestinationhasDestinationgetDischargeDispositionsetDischargeDispositionhasDischargeDispositionfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitDietPreferenceinitSpecialCourtesyinitSpecialArrangement