Server (Cells) Messaging Home
Space shortcuts
Space Tools

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
_Toc421529992
_Toc421529992
Anchor
_Toc439749925
_Toc439749925
Scenario: Upload data in patient data object XML

The data load request message can be divided into three sections.

  1. The <input_list> specifies the location of the PDO document.
  2. The <load_list> specifies the PDO sections to load.
  3. The <output_list> specifies the output expected from the upload process.



In addition, certain dependencies exist for loading some section of the PDO. The following table shows the dependencies for loading the individual PDO section.

Load PDO section

Dependent PDO section

event_set

eid_set

patient_set

pid_set

observation_set

eid_set, pid_set, event_set, patient_set

concept_set, modifier_set, observer_set, eid_set, pid_set

NONE



The example shown below contains the sections of the PDO XML that are required to load a single observation fact.

  • Note
    The dependency section in the PDO is optional; if they exist in the data mart

...



Response Message:
<message_body>
<load_data_response>
<status>
<condition type="ERROR|DONE" coding_system="">
error message
</condition>
</status>
<upload_id>upload_id0</upload_id>
<user_id>user_id0</user_id>
<data_file_location_uri protocol_name="FR|LOCAL">
location_uri0
</data_file_location_uri>
<load_status>load_status0</load_status>
<transformer_name>transformer_name0</transformer_name>
<start_date>2006-05-04T18:13:51.0Z</start_date>
<end_date>2006-05-04T18:13:51.0Z</end_date>
<message>message0</message>
<observation_set inserted_record="0" ignored_record="0" total_record="0">
<ignored_patient_data_file_uri protocol_name="FR|LOCAL">
uri0
</ignored_patient_data_file_uri>
<message>message1</message>
</observation_set>
<patient_set inserted_record="0" ignored_record="0" total_record="0">
<ignored_patient_data_file_uri protocol_name="FR|LOCAL">
</ignored_patient_data_file_uri>
<message>message2</message>
</patient_set>
<event_set inserted_record="0" ignored_record="0" total_record="0">
</event_set>
<observer_set inserted_record="0" ignored_record="0" total_record="0">
</observer_set>
<concept_set inserted_record="0" ignored_record="0" total_record="0">
</concept_set>
<modifier_set inserted_record="0" ignored_record="0" total_record="0">
</modifier_set>
<pid_set inserted_record="0" ignored_record="0" total_record="0">
</pid_set>
<eventid_set inserted_record="0" ignored_record="0" total_record="0">
</eventid_set>
</load_data_response>
</message_body>

Anchor
_Toc421529993
_Toc421529993
Anchor
_Toc439749926
_Toc439749926
Scenario: Get upload status info by upload_id and user_id

This message will retrieve one of the following:

  1. A list of upload status information based on the user_id
  2. A single upload status by upload_id



Request Message:
<message_body>
<get_upload_info_request>
<user_id>user_id</user_id>
<upload_id>100</upload_id>
</get_upload_info_request>
</message_body>

Response Message:
<message_body>
<load_data_list_response>
<load_data_response>
Please refer section 4.5.1.1 for <load_data_response/>
</load_data_response>
. . .
</load_data_list_response>
</message_body>

Anchor
_Toc421529994
_Toc421529994
Anchor
_Toc439749927
_Toc439749927
Scenario: Find the unmapped term in the datamart

This service returns a count for the number of concepts, modifiers and providers that considered "unmapped". A term is "unmapped" when it is found in the fact table and is missing from the corresponding dimension table.
The unmapped term can be requested for a particular upload or for the entire data mart. If detail="true" then the service will return the list of unmapped terms.
Request Message:
<message_body>
<get_missing_term_request upload_id="NN" detail="true | false">
<concept_set start="1" end="1000" />
<modifier_set start="1" end="1000" />
<observer_set start="1" end="1000" />
</get_missing_term_request>
</message_body>

Response Message:
<message_body>
<missing_term_report_response>
<missing_term_report upload_id="22">
<concept_set mapped="41683182" unmapped=""/>
<modifier_set mapped="41683182" unmapped="" />
<observation_set mapped="41683182" unmapped=""/>
</missing_term_report>
<missing_codes>
<concept_set>
<concept missing_total="9">
<concept_cd>brine:ses5</concept_cd>
</concept>
<concept missing_total="5">
<concept_cd>MTP:KGC</concept_cd>
</concept>
</concept_set>
<observer_set>
<observer/>
</observer_set>
<modifier_set>
<modifier/>
</modifier_set>
</missing_codes>
</missing_term_report_response >
</message_body>