LA Web Services

What is a Web Service?

“Web service is an XML-based information exchange mechanism that uses the Internet for direct application-to-application interaction. It is a collection of open protocols and standards used for exchanging data between applications or systems. Software applications written in various programming languages and running on various platforms can use web services to exchange data over computer networks like the Internet in a manner similar to inter-process communication on a single computer.”¹

_{1 Quoted from the Los Angeles County Department of Mental Health Companion Guide Document.
LACDMH_ClientWebServices_CompanionGuide_v2.4.pdf}

LA Web Services

Use myAvatar LA Provider Integration module to generate/accept the following BizTalk web services:

•  AdmitExistingClient
  • This operation is intended to allow Trading Partners the ability to admit existing IBHIS clients to their respective Programs. Authenticated Trading Partners are authorized to admit existing clients. A precondition is the client exists in IBHIS. The Trading Partner is required to perform a search by invoking the SearchClient operation, using the client’s demographics. 
  • The operation will create a new episode in Trading Partner’s program with Admission information, Demographics data and depending on the selection on Ref# 31, it will also create a Financial Eligibility record. When ‘MediCalClient’ is submitted as the type in ClientFinEligibility (Ref#31), MediCal and LA County guarantor entries will be established for the client. When ‘NonMediCalClient’ is submitted as the type in ClientFinEligibility (Ref#31), an LA County guarantor entry will be established for the client.²
•  AdmitNewClient
  • This operation is intended to allow Trading Partners the ability to create and admit clients to their respective Programs in IBHIS.
  • The Trading Partner is required to perform a search by invoking the SearchClient operation, using the client’s demographics, prior to creating a new client entry. 
  • When the AdmitNewClient operation is successfully invoked, a new admission will be filed in IBHIS for the newly created client. In addition Financial Eligibility will be established for the client in the admission process. When ‘MediCalClient’ is submitted as the type in ClientFinEligibility (Ref#30), MediCal and LA County guarantor entries will be established for the client. When ‘NonMediCalClient’ is submitted as the type in ClientFinEligibility (Ref#30), an LA County guarantor entry will be established for the client. ³ 
• CreateClientCSI
  • This operation is intended to capture mandated CSI information. Authenticated Trading Partners are authorized to submit CSI information as
    needed to satisfy Departmental mandates for clients admitted to their respective programs. A precondition is the client must exist in IBHIS, and
    the Trading Partner must have successfully admitted the client to their Program. It is required that Trading Partners call this operation after
    opening an episode for a client in IBHIS. ⁴
• CreateClientDiagnosis
• This operation is intended to capture client diagnosis information. Authenticated Trading Partners are authorized to submit an “Admission”, “Update” or “Discharge” Diagnosis record for a given admission. A precondition is the client must exist in IBHIS and the Trading Partner must have successfully admitted the client to their Program. This operation should be used to record all diagnosis entries in IBHIS. The TypeofDiagnosis ‘Admission’ is expected when submitting an initial diagnosis subsequent to admission. The TypeofDiagnosis ‘Update’ is expected to capture any change of diagnosis which differs from the ‘Admission’ diagnosis. The ‘Discharge’ type should only be submitted when the client is deceased and a discharge diagnosis is to be filed.⁵
• CreateClientPregnancy
• This operation is intended to capture Pregnancy related information for female clients. Authenticated Trading Partners are authorized to enter a new Pregnancy record for female clients admitted to their Programs. . A precondition is the female client must exist in IBHIS , the Trading Partner must have successfully admitted the female client to their Program, and no existing Pregnancy information is recorded in IBHIS. The use of this operation assumes the Trading Partners have requested existing Pregnancy information via the GetClientPregnancyDetails operation.
• When the GetClientPregnancyDetails operation does not return information, the CreateClientPregnancy operation should be used. When the information returned by the GetClientPregnancyDetails operation is no longer current the UpdateClientPregnancyDetails operation should be used. This operation is optional for female clients.⁶
• CreateClientUMDAP
• This operation is intended to capture Uniform Method for Determining Ability to Pay (UMDAP) information. Authenticated Trading Partners are authorized to enter a new UMDAP record for a known client to the Trading Partner, representing the annual liability period established during financial screening. A precondition is the client must exist in IBHIS. The use of this operation assumes the Trading Partner has requested information via the GetClientUMDAPDetails operation. If no existing UMDAP information is returned or the current UMDAP information for client, representing the annual liability period, has lapsed then CreateClientUMDAP operation should be used. If the existing UMDAP information returned via the GetClientUMDAPDetails operation needs to be updated then UpdateClientUMDAP operation should be used.
• It is recommended that Trading Partners invoke this operation after opening an episode for a client in IBHIS. Trading Partners are not required to admit a client in order to use this operation.⁷
• DischargeClient
• This operation is intended to provide Trading Partners the ability to Discharge an existing, open 24 Hour or Outpatient episode in IBHIS. Authenticated Trading Partners are authorized to Discharge any client admitted to their respective program. ⁸
• GetClientActiveEpisode
• This operation is intended to retrieve the current active admission for an existing IBHIS client. Authenticated Trading Partners are authorized to retrieve admission information for an existing IBHIS client. A precondition is the client must exist in IBHIS and the Trading Partner must have successfully admitted the client to their Program.⁹
• GetClientCSI
• This operation is intended to retrieve client’s CSI information from IBHIS. Authenticated Trading Partners are authorized to retrieve existing CSI information. A precondition is the client must exist in IBHIS, and the Trading Partner must have successfully admitted the client to their Program.¹⁰
• GetClientDetails
• This operation is intended to allow Trading Partners the ability to retrieve existing IBHIS client information. Authenticated Trading Partners are authorized to retrieve information for all existing IBHIS clients. A precondition is the client exists in IBHIS. The Trading Partner is required to perform a search by invoking the SearchClient operation, using the client’s Demographics. 
• Once a client match is established, the GetClientDetails operation can be invoked to return the detailed demographic information captured in IBHIS. It is required that Trading Partners invoke this operation, prior to updating any client information. ¹¹
• GetClientDiagnosis
• This operation is intended to retrieve client diagnosis information. Authenticated Trading Partners are authorized to retrieve detailed Diagnosis information for clients admitted to their respective programs. A precondition is the client must exist in IBHIS and the Trading Partner must have successfully admitted the client to their Program, and an existing diagnosis entry must have been recorded in IBHIS. ¹²
• GetClientDiagnosisHistory
• This operation is intended to retrieve a client’s historical Primary diagnosis summary information. Authenticated Trading Partners are authorized to retrieve historical Diagnosis summary information for any existing IBHIS client. A precondition is the client must exist in IBHIS, and the client must have existing Primary diagnosis entries recorded in IBHIS.¹³
• GetClientEpisodeHist
• This operation is intended to retrieve the admission history for an existing IBHIS client. Authenticated Trading Partners are authorized to retrieve historical admission information for any existing IBHIS client. A precondition is the client must exist in IBHIS. ¹⁴
• GetClientFinEligibility
• This operation is intended to retrieve Financial Eligibility information related to a client admission. Authenticated Trading Partners are authorized to retrieve Financial Eligibility pertaining to admissions for their respective programs. A precondition is the client must exist in IBHIS, the Trading Partner must have successfully admitted the client to their Program, and an existing Financial Eligibility is recorded in IBHIS. When the GetClientFinEligibility operation returns information which is no longer current or relevant the UpdateClientFinEligibility operation should be used. Please note, only MediCal and LACounty guarantors can be established when submitting Financial Eligibility. It is required that Trading Partners invoke this operation after opening an episode for a client in IBHIS, in order to ensure proper adjudication of claims. Trading Partners are required to have a current Financial Eligibility recorded with IBHIS in order to successfully claim. ¹⁵
• GetClientLegacySvcHist
• This operation is intended to retrieve non-converted clients and their associated service history. Authenticated Trading Partners are authorized to retrieve existing legacy service history entries. The data delivered by this service is based on IS episodes that are associated with clients that have records in myAvatar , thus it functions similarly to an “episode lookup” in the IS. This data has been extracted from the IS and imported into IBHIS so that it is available for review from within IBHIS. As such it is derived from discrete extraction and load events as opposed to real time integration between the two systems. Data is accessed by submitted the valid IBHIS ClientID for the associated client. ¹⁶
• GetClientPregnancyDetails
• This operation is intended to retrieve Pregnancy related information for female clients. Authenticated Trading Partners are authorized to retrieve existing Pregnancy information for female clients admitted to their Programs. A precondition is the female client must exist in IBHIS , the Trading Partner must have successfully admitted the female client to their Program, and existing Pregnancy information is recorded in IBHIS. When the GetClientPregnancyDetails operation does not return information, the CreateClientPregnancy operation should be invoked. When the information returned by the GetClientPregnancyDetails operation is no longer current the UpdateClientPregnancyDetails operation should be used. This operation is optional for female clients. When updating Pregnancy information, any optional fields omitted with result in blank values being stored for the Pregnancy entry. ¹⁷
• GetClientSvcHist
• This operation is intended to retrieve IBHIS client service history. Authenticated Trading Partners are authorized to retrieve existing service history entries. The preconditions are:
  1. Client must exist in IBHIS
  2. Trading Partner must have successfully admitted the client to their Program
  3. Services have been approved in MSO and sent to PM (MSO and PM are two modules in IBHIS).¹⁸
• GetClientUMDAPDetails
• This operation is intended to retrieve Uniform Method for Determining Ability to Pay (UMDAP) information. Authenticated Trading Partners are authorized to retrieve existing UMDAP information, representing the annual liability period established during financial screening, for any existing IBHIS client. A precondition is the client must exist in IBHIS, the client must have an existing UMDAP entry. It is required that Trading Partners invoke this operation, prior to updating any client information. Trading Partners are not required to admit a client in order to use this operation. ¹⁹
• GetDCFSClientSvcHist
• This operation is intended to retrieve case information for clients involved with the Los Angeles County Department of Children and Family Services (DCFS). Authenticated Trading Partners are authorized to retrieve existing DCFS case information for clients admitted to their Programs.²⁰
• GetPublicGuardianSvcHist
• This operation is intended to retrieve case information for clients involved with the Los Angeles County Public Guardians’ Office. Authenticated Trading Partners are authorized to retrieve existing Public Guardian case information for clients admitted to their Programs.²¹
• SearchClient
• This operation is intended to provide Trading Partners the ability to search existing clients recorded in IBHIS. Authenticated Trading Partners are authorized to search all existing clients in IBHIS. The use of this operation is required prior to creating and/or admitting any client.²²
• UpdateClientDetails
• This operation is intended to update Demographics and CSI information for existing IBHIS clients. Authenticated Trading Partners are authorized to update Demographics and CSI data for a client in IBHIS. A precondition is the client must exist in IBHIS, and the Trading Partner must have successfully admitted the client to their Program. When updating Demographics, all optional fields will only be overwritten if a value is provided, otherwise the existing entry will persist the field, with the exception of StreetAddress2. When updating CSI information, if a value is not provided for any of the optional fields, the fields will remain empty for that CSI entry.²³
• UpdateClientDiagnosis
• This operation is intended to correct any erroneous entry for existing client diagnosis information in IBHIS. Authenticated Trading Partners are authorized to submit corrections for an “Admission”, “Update” or “Discharge” Diagnosis record for a given admission. Preconditions are:
  1. Client must exist in IBHIS,
  2. The Trading Partner must have successfully admitted the client to their Program,
  3. A diagnosis entry exists for the episode.
• Please note when correcting any diagnosis entry, the TypeOfDiagnosis which has been filed through CreateClientDiagnosis, should not be changed and is expected when submitting error corrections via the UpdateClientDiagnosis operation. ²⁴
• UpdateClientFinEligibility
• This operation is intended to capture updates to Financial Eligibility information related to a client admission. Authenticated Trading Partners are authorized to update Financial Eligibility records for admissions to their respective program. Preconditions are:
  1. The client must exist in IBHIS and
  2. The Trading Partner must have successfully admitted the client to their Program.
• The use of this operation assumes the Trading Partners have requested existing Financial Eligibility via the GetClientFinEligibility operation.²⁵
• UpdateClientPregnancy
• This operation is intended to update Pregnancy related information for female clients. Authenticated Trading Partners are authorized to update an existing Pregnancy record for female clients admitted to their Programs. A precondition is the female client must exist in IBHIS , the Trading Partner must have successfully admitted the female client to their Program, and existing Pregnancy information is recorded in IBHIS. The use of this operation assumes the Trading Partners have requested existing Pregnancy information via the GetClientPregnancyDetails operation.
• When the GetClientPregnancyDetails operation does not return information, the CreateClientPregnancy operation should be used. When the information returned by the GetClientPregnancyDetails operation is no longer current the UpdateClientPregnancyDetails operation should be used. This operation is optional for female clients. When updating Pregnancy information, any optional fields omitted with result in blank values being stored for the Pregnancy entry. 26
• UpdateClientUMDAP
• This operation is intended to capture updates to Uniform Method for Determining Ability to Pay (UMDAP) information. Authenticated Trading Partners are authorized to update existing UMDAP information, representing the annual liability period established during financial screening, for any existing IBHIS client. A precondition is the client must exist in IBHIS, the client must have an existing UMDAP entry, and the client’s annual liability period has not lapsed.
• The use of this operation assumes the Trading Partner has requested information via the GetClientUMDAPDetails operation. When the existing UMDAP information returned is not current or has lapsed the CreateClientUMDAP operation should be invoked to create a new UMDAP entry representing the new annual liability period. When the existing UMDAP information returned via the GetClientUMDAPDetails operation needs to be updated, or the annual liability amount has been spent down, the UpdateClientUMDAP operation should be used. It is recommended that Trading Partners invoke this operation after opening an episode for a client in IBHIS. Trading Partners are not required to admit a client in order to use this operation. ²⁷

_{2 - 27 Quoted from the Los Angeles County Department of Mental Health Companion Guide Document.
DMH_ClientServices_CompanionGuide-v2.8.pdf}

Admit New & Existing Client Web Service Financial Eligibility Workflow

The following workflow shows the checks that must take place within myAvatar before the AdmitNewClient, or AdmitExistingClient web services can be processed.