Class EpisodeOfCare

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class EpisodeOfCare
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR EpisodeOfCare Resource (workflow.encounter)

    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.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/EpisodeOfCare

    See Also:
    Serialized Form
    • Field Detail

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: EpisodeOfCare.patient

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: EpisodeOfCare.identifier

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter constant for status

        Description: The current status of the Episode of Care as provided (does not check the status history collection)
        Type: token
        Path: EpisodeOfCare.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: The current status of the Episode of Care as provided (does not check the status history collection)
        Type: token
        Path: EpisodeOfCare.status

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter constant for organization

        Description: The organization that has assumed the specific responsibilities of this EpisodeOfCare
        Type: reference
        Path: EpisodeOfCare.managingOrganization

        See Also:
        Constant Field Values
      • ORGANIZATION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
        Fluent Client search parameter constant for organization

        Description: The organization that has assumed the specific responsibilities of this EpisodeOfCare
        Type: reference
        Path: EpisodeOfCare.managingOrganization

      • SP_DATE

        public static final String SP_DATE
        Search parameter constant for date

        Description: The provided date search value falls within the episode of care's period
        Type: date
        Path: EpisodeOfCare.period

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: The provided date search value falls within the episode of care's period
        Type: date
        Path: EpisodeOfCare.period

      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description:
        Type: token
        Path: EpisodeOfCare.type

      • CONDITION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONDITION
        Fluent Client search parameter constant for condition

        Description:
        Type: reference
        Path: EpisodeOfCare.condition

      • SP_INCOMINGREFERRAL

        public static final String SP_INCOMINGREFERRAL
        Search parameter constant for incomingreferral

        Description: Incoming Referral Request
        Type: reference
        Path: EpisodeOfCare.referralRequest

        See Also:
        Constant Field Values
      • INCOMINGREFERRAL

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INCOMINGREFERRAL
        Fluent Client search parameter constant for incomingreferral

        Description: Incoming Referral Request
        Type: reference
        Path: EpisodeOfCare.referralRequest

      • CARE_MANAGER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CARE_MANAGER
        Fluent Client search parameter constant for care-manager

        Description:
        Type: reference
        Path: EpisodeOfCare.careManager

      • SP_TEAM_MEMBER

        public static final String SP_TEAM_MEMBER
        Search parameter constant for team-member

        Description: A Practitioner or Organization allocated to the care team for this EpisodeOfCare
        Type: reference
        Path: EpisodeOfCare.careTeam.member

        See Also:
        Constant Field Values
      • TEAM_MEMBER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TEAM_MEMBER
        Fluent Client search parameter constant for team-member

        Description: A Practitioner or Organization allocated to the care team for this EpisodeOfCare
        Type: reference
        Path: EpisodeOfCare.careTeam.member

      • INCLUDE_CARE_MANAGER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_CARE_MANAGER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "EpisodeOfCare:care-manager".
      • INCLUDE_CONDITION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_CONDITION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "EpisodeOfCare:condition".
      • INCLUDE_INCOMINGREFERRAL

        public static final ca.uhn.fhir.model.api.Include INCLUDE_INCOMINGREFERRAL
        Constant for fluent queries to be used to add include statements. Specifies the path value of "EpisodeOfCare:incomingreferral".
      • INCLUDE_ORGANIZATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "EpisodeOfCare:organization".
      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "EpisodeOfCare:patient".
      • INCLUDE_TEAM_MEMBER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_TEAM_MEMBER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "EpisodeOfCare:team-member".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: Identifier(s) by which this EpisodeOfCare is known

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: Identifier(s) by which this EpisodeOfCare is known

      • addIdentifier

        public EpisodeOfCare addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: Identifier(s) by which this EpisodeOfCare is known

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: Identifier(s) by which this EpisodeOfCare is known

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<EpisodeOfCareStatusEnumgetStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: planned | waitlist | active | onhold | finished | cancelled

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: planned | waitlist | active | onhold | finished | cancelled

      • setStatus

        public EpisodeOfCare setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<EpisodeOfCareStatusEnum> theValue)
        Sets the value(s) for status (status)

        Definition: planned | waitlist | active | onhold | finished | cancelled

      • getStatusHistory

        public List<EpisodeOfCare.StatusHistorygetStatusHistory()
        Gets the value(s) for statusHistory (). creating it if it does not exist. Will not return null.

        Definition: The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource)

      • addStatusHistory

        public EpisodeOfCare.StatusHistory addStatusHistory()
        Adds and returns a new value for statusHistory ()

        Definition: The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource)

      • addStatusHistory

        public EpisodeOfCare addStatusHistory​(EpisodeOfCare.StatusHistory theValue)
        Adds a given new value for statusHistory ()

        Definition: The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource)

        Parameters:
        theValue - The statusHistory to add (must not be null)
      • getStatusHistoryFirstRep

        public EpisodeOfCare.StatusHistory getStatusHistoryFirstRep()
        Gets the first repetition for statusHistory (), creating it if it does not already exist.

        Definition: The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource)

      • getType

        public List<CodeableConceptDtgetType()
        Gets the value(s) for type (class). creating it if it does not exist. Will not return null.

        Definition: A classification of the type of encounter; e.g. specialist referral, disease management, type of funded care

      • setType

        public EpisodeOfCare setType​(List<CodeableConceptDt> theValue)
        Sets the value(s) for type (class)

        Definition: A classification of the type of encounter; e.g. specialist referral, disease management, type of funded care

      • addType

        public CodeableConceptDt addType()
        Adds and returns a new value for type (class)

        Definition: A classification of the type of encounter; e.g. specialist referral, disease management, type of funded care

      • addType

        public EpisodeOfCare addType​(CodeableConceptDt theValue)
        Adds a given new value for type (class)

        Definition: A classification of the type of encounter; e.g. specialist referral, disease management, type of funded care

        Parameters:
        theValue - The type to add (must not be null)
      • getTypeFirstRep

        public CodeableConceptDt getTypeFirstRep()
        Gets the first repetition for type (class), creating it if it does not already exist.

        Definition: A classification of the type of encounter; e.g. specialist referral, disease management, type of funded care

      • getCondition

        public List<ResourceReferenceDtgetCondition()
        Gets the value(s) for condition (what). creating it if it does not exist. Will not return null.

        Definition: A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for

      • setCondition

        public EpisodeOfCare setCondition​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for condition (what)

        Definition: A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for

      • addCondition

        public ResourceReferenceDt addCondition()
        Adds and returns a new value for condition (what)

        Definition: A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for

      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.

        Definition: The patient that this EpisodeOfCare applies to

      • getManagingOrganization

        public ResourceReferenceDt getManagingOrganization()
        Gets the value(s) for managingOrganization (). creating it if it does not exist. Will not return null.

        Definition: The organization that has assumed the specific responsibilities for the specified duration

      • getPeriod

        public PeriodDt getPeriod()
        Gets the value(s) for period (when.init). creating it if it does not exist. Will not return null.

        Definition: The interval during which the managing organization assumes the defined responsibility

      • setPeriod

        public EpisodeOfCare setPeriod​(PeriodDt theValue)
        Sets the value(s) for period (when.init)

        Definition: The interval during which the managing organization assumes the defined responsibility

      • getReferralRequest

        public List<ResourceReferenceDtgetReferralRequest()
        Gets the value(s) for referralRequest (). creating it if it does not exist. Will not return null.

        Definition: Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals

      • addReferralRequest

        public ResourceReferenceDt addReferralRequest()
        Adds and returns a new value for referralRequest ()

        Definition: Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals

      • getCareManager

        public ResourceReferenceDt getCareManager()
        Gets the value(s) for careManager (). creating it if it does not exist. Will not return null.

        Definition: The practitioner that is the care manager/care co-ordinator for this patient

      • getCareTeam

        public List<EpisodeOfCare.CareTeamgetCareTeam()
        Gets the value(s) for careTeam (). creating it if it does not exist. Will not return null.

        Definition: The list of practitioners that may be facilitating this episode of care for specific purposes

      • addCareTeam

        public EpisodeOfCare.CareTeam addCareTeam()
        Adds and returns a new value for careTeam ()

        Definition: The list of practitioners that may be facilitating this episode of care for specific purposes

      • addCareTeam

        public EpisodeOfCare addCareTeam​(EpisodeOfCare.CareTeam theValue)
        Adds a given new value for careTeam ()

        Definition: The list of practitioners that may be facilitating this episode of care for specific purposes

        Parameters:
        theValue - The careTeam to add (must not be null)
      • getCareTeamFirstRep

        public EpisodeOfCare.CareTeam getCareTeamFirstRep()
        Gets the first repetition for careTeam (), creating it if it does not already exist.

        Definition: The list of practitioners that may be facilitating this episode of care for specific purposes

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource