Data Model Libraries
    Preparing search index...

    Class EpisodeOfCare

    EpisodeOfCare Class

    An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

    FHIR Specification

    • Short: An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
    • Definition: An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
    • FHIR Version: 4.0.1

    FHIR EpisodeOfCare

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? episodeOfCareStatusEnum status statusHistory? type_? diagnosis? patient managingOrganization? period? referralRequest? careManager? team? account?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusHistory setStatusHistory addStatusHistory hasStatusHistory getType setType addType hasType getDiagnosis setDiagnosis addDiagnosis hasDiagnosis getPatient setPatient hasPatient getManagingOrganization setManagingOrganization hasManagingOrganization getPeriod setPeriod hasPeriod getReferralRequest setReferralRequest addReferralRequest hasReferralRequest getCareManager setCareManager hasCareManager getTeam setTeam addTeam hasTeam getAccount setAccount addAccount hasAccount 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 initType initDiagnosis initReferralRequest initTeam initAccount

    Constructors

    Properties

    identifier?: Identifier[]

    EpisodeOfCare.identifier Element

    FHIR Specification

    • Short: Business Identifier(s) relevant for this EpisodeOfCare
    • Definition: The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    episodeOfCareStatusEnum: EpisodeOfCareStatusEnum

    FHIR CodeSystem: EpisodeOfCareStatus

    EpisodeOfCareStatusEnum

    status: null | EnumCodeType

    EpisodeOfCare.status Element

    FHIR Specification

    • Short: planned | waitlist | active | onhold | finished | cancelled | entered-in-error
    • Definition: planned | waitlist | active | onhold | finished | cancelled.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled 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: EpisodeOfCareStatusEnum

    statusHistory?: EpisodeOfCareStatusHistoryComponent[]

    EpisodeOfCare.statusHistory Element

    FHIR Specification

    • Short: Past list of status codes (the current status may be included to cover the start date of the status)
    • Definition: The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Private Optionaltype_

    type_?: CodeableConcept[]

    EpisodeOfCare.type Element

    FHIR Specification

    • Short: Type/class - e.g. specialist referral, disease management
    • Definition: A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
    • Comment: The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    diagnosis?: EpisodeOfCareDiagnosisComponent[]

    EpisodeOfCare.diagnosis Element

    FHIR Specification

    • Short: The list of diagnosis relevant to this episode of care
    • Definition: The list of diagnosis relevant to this episode of care.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    patient: null | Reference

    EpisodeOfCare.patient Element

    FHIR Specification

    • Short: The patient who is the focus of this episode of care
    • Definition: The patient who is the focus of this episode of care.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    managingOrganization?: Reference

    EpisodeOfCare.managingOrganization Element

    FHIR Specification

    • Short: Organization that assumes care
    • Definition: The organization that has assumed the specific responsibilities for the specified duration.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    EpisodeOfCare.period Element

    FHIR Specification

    • Short: Interval during responsibility is assumed
    • Definition: The interval during which the managing organization assumes the defined responsibility.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    referralRequest?: Reference[]

    EpisodeOfCare.referralRequest Element

    FHIR Specification

    • Short: Originating Referral Request(s)
    • Definition: Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    careManager?: Reference

    EpisodeOfCare.careManager Element

    FHIR Specification

    team?: Reference[]

    EpisodeOfCare.team Element

    FHIR Specification

    • Short: Other practitioners facilitating this episode of care
    • Definition: The list of practitioners that may be facilitating this episode of care for specific purposes.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    account?: Reference[]

    EpisodeOfCare.account Element

    FHIR Specification

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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EpisodeOfCare

      • OptionaloptSourceField: string

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

      Returns undefined | EpisodeOfCare

      EpisodeOfCare data model or undefined for EpisodeOfCare

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided ManagingOrganization object value to the managingOrganization property.

      Parameters

      • value: undefined | Reference

        the managingOrganization object value

      Returns this

      this

      @ReferenceTargets('EpisodeOfCare.managingOrganization', ['Organization',])

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusHistorysetStatusHistoryaddStatusHistoryhasStatusHistorygetTypesetTypeaddTypehasTypegetDiagnosissetDiagnosisaddDiagnosishasDiagnosisgetPatientsetPatienthasPatientgetManagingOrganizationsetManagingOrganizationhasManagingOrganizationgetPeriodsetPeriodhasPeriodgetReferralRequestsetReferralRequestaddReferralRequesthasReferralRequestgetCareManagersetCareManagerhasCareManagergetTeamsetTeamaddTeamhasTeamgetAccountsetAccountaddAccounthasAccountfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitStatusHistoryinitTypeinitDiagnosisinitReferralRequestinitTeaminitAccount