Load Subject Instance

Topics:

Use the following REST call to initiate the load and mastering process for a subject in Omni-HealthData. Omni-HealthData will take the subject information in the form of an OID XML and will perform requested cleansing, matching, and merging of the subject.

Omni-HealthData can process fully qualified or partial OID XML documents. The required SourceName and SourceInstanceId elements are used by Omni-HealthData to determine whether a subject is new or an update to a previous instance. Omni-HealthData will construct the best possible subject document by intelligently combining the current subject instance with previous instance data. This intelligent combination may be configured at the document, source, subject, or source/subject levels.

PUT: /server/api/v1/server/instance?mode=&timeout=

Topics:

The data must be a correctly formatted OID XML, which minimally requires a SourceName and SourceInstanceId. The OID may be fully qualified or partially qualified.

  • mode – Specify the loading mode of sync or async. The default is async, as sync will block the caller until the data is fully processed or a timeout occurs.
  • timeout – When mode=sync, the caller will be blocked until the document is fully processed or until this timeout is exceeded.

Example:

PUT https://localhost:9514/server/api/v1/server/instance

Content-Type: application/xml

<customer>
       <SourceName>ReadTest</SourceName>
       <SourceInstanceId>ReadTestCustomer</SourceInstanceId>
       <cu_title>DEVELOPER</cu_title>
       <cu_salutation>MR</cu_salutation>
       <cu_suffix>PHD</cu_suffix>
       <cu_first_name>SCOTT</cu_first_name>
       <cu_middle_name>W</cu_middle_name>
       <cu_last_name>BISHOPP</cu_last_name>
       <cu_full_name>MR SCOTT W BISHOPP PHD</cu_full_name>
       <cu_gender>M</cu_gender>
       <cu_dob format="yyyy-MM-dd">1965-02-21</cu_dob>
       <cu_ssn>874-98-4546</cu_ssn>
       <cu_type>P</cu_type>
       <cu_bus_name>IBI</cu_bus_name>
       <cu_dba_name>SCOTTYB</cu_dba_name>
       <cust_addressOmniCollection>
         <customercust_address version="">
             <SourceName>ReadTest</SourceName>
             <SourceInstanceId>ReadTest:address</SourceInstanceId>
           <ad_1>4212 S LIVONIA RD</ad_1>
           <ad_2>ATTN: SCOTT BISHOPP</ad_2>
           <ad_city>LIVONIA</ad_city>
           <ad_state>NY</ad_state>
           <ad_zip>14487</ad_zip>
           <ad_zip4>0212</ad_zip4>
           <ad_country>US</ad_country>
         </customercust_address>
       </cust_addressOmniCollection>
   </customer>

- response -

200 OK
Server:  Apache-Coyote/1.1
X-Application-Context:  application:9500
Content-Type:  application/xml;charset=UTF-8
Content-Length:  202
Date:  Tue, 08 May 2018 15:34:06 GMT
<RestResponse>  
  <status>0</status>  
  <statusText></statusText>  
  <responseType>java.lang.String</responseType>  
  <response>
  Submitted request for customer:ReadTest:ReadTestCustomer
  </response>
</RestResponse>