Page History
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
This request is divided into three parts:
- input_list
The input_list accepts either the id of the patient set or a list of patient ids.
- filter_list
The filter_list holds a list of panels. The panels have the item details that are used in constructing a PDO query.
- output_option
The output_option specifies which set of patient data to return.
Each of the patient data sections in the output_option has attributes to specify the level of detail data that is expected in the response.
Request Type | Request | Response |
getPDO_fromInputList | GetPDOFromInputList_requestType | master_responseType |
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
The input list to the PDO request can be in one of the following formats. i.e. the patient_list, encounter_list, pid_list, and eid_list.
Element Name | Description |
patient_list | The patient_list input can be in one of these three forms.
|
encounter_list | The encounter_list input format is similar to the patient_list. This list can be in one of three forms.
|
pid_list | The pid_list consists of a list of enumerated patient ids (patient_ide) and their source value. This input allows the user to query the data via the patient_ide and its source. The PDO service first maps the patient_ide to the patient_num before querying the datamart. |
eid_list | The eid_list consists of a list of enumerated encounter ids (encounter_ide) and their source value. This input allows the user to query the data via the encounter_ide and its source. The PDO service first maps the encounter_ide to the encounter_num before querying the datamart. |
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Please refer to the earlier section titled Panel Definition Detail.
The LARGETEXT search in the panel definition requires the minimum of DATA_DEID user role.
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
This option specifies the list of sections that is required in the PDO response.
Attribute Name | Description | Implemented | |
name = "asattributes | none" | This option specifies to return the names for the codes when returning the PDO data. The names for the codes are available in the CODE_LOOKUP table. | Yes |
phi = "encrypted | unencrypted" | Â | No |
time = "nozone | withzone" | Â | No |
Example:
<!-- output options -->
<output_option name="asattributes">
<patient_set select="using_filter_list" onlykeys="true"/>
<concept_set_using_filter_list select="using_filter_list" onlykeys="true"/>
<modifier_set_using_filter_list select="using_filter_list" onlykeys="true"/>
<observation_set selectionfilter="min_value" withmodifiers="true" blob="false" onlykeys="false"/>
<event_set select="using_filter_list" onlykeys="true"/>
<pid_set select="using_filter_list" onlykeys="true"/>
<eid_set select="using_filter_list" onlykeys="true"/>
<observer_set_using_filter_list onlykeys="true"/>
</output_option>
The following are the available options for each element in the <output_option>.
Attribute Name | Description | Implemented | |||||
onlykeys = "true | false" | If this option is "true" then only the primary keys will be returned. | Â | ||||
blob = "true | false" | This option specifies whether the blob field is required in the output. The blob option requires the minimum of DATA_DEID user role. | Â | ||||
techdata = "true | false" | This option specifies whether the blob field is required in the output. The blob option requires the minimum of DATA_DEID user role. | Â | ||||
select = "using_filter_list | using_input_list" | There are a couple of ways to select the PDO data. | Â | ||||
selectionfilter = "min_value | max_value | first_value | last_value | single_observation | last_n_values" | This option will retrieve specific results depending on which one is defined in the xml message. | Â |
...
Example:
<message_body>
<crc:pdoheader>
<request_type>getPDO_fromInputList</request_type>
</crc:pdoheader>
<crc:request xsi:type="ns2:GetPDOFromInputList_requestType"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- inputlist -->
<input_list>
<patient_list max="300" min="1">
<patient_set_coll_id>100</patient_set_coll_id>
</patient_list>
<!--or-->
<event_list/>
<!--or-->
<pid_list min="1" max="3">
<pid index="1" source="HIVE">9876</pid>
<pid index="3" source="HIVE">1</pid>
</pid_list>
<!--or-->
<eid_list min="1" max="5">
<eid index="1" source="HIVE">12222313</eid>
</eid_list>
</input_list>
<!-- filterlist -->
<filter_list>
<panel name="panel1">
<panel_invert>0</panel_invert>
<panel_accuracy_scale></panel_accuracy_scale>
<panel_start_date></panel_start_date>
<panel_end_date></panel_end_date>
<item>
<item_name></item_name>
<item_key></item_key>
<constrain_by_value>
<value_operator></value_operator>
<value_constraint>value_constraint0</value_constraint>
<value_unit_of_measure>unit</value_unit_of_measure>
<value_type></value_type>
</constrain_by_value>
<constrain_by_modifier>
<applied_path>\i2b2\Medications%</applied_path>
<modifier_key>\\i2b2_DEMO\Dose{color:#0000ff}</modifier_key>
<constrain_by_value>
<value_operator></value_operator>
<value_constraint> </value_constraint>
<value_unit_of_measure></value_unit_of_measure>
<value_type></value_type>
</constrain_by_value>
</constrain_by_modifier>
<constrain_by_date>
</constrain_by_date>
</item>
. . .
</panel>
<panel name="panel2">
<panel_invert>0</panel_invert>
<panel_accuracy_scale></panel_accuracy_scale>
<panel_start_date></panel_start_date>
<panel_end_date></panel_end_date>
<item>
<item_name> </item_name>
<item_key> </item_key>
<constrain_by_value>
<value_type></value_type>
<value_operator></value_operator>
<value_unitofmeasure></value_unitofmeasure>
<value></value>
</constrain_by_value>
<constrain_by_modifier></constrain_by_modifier>
<constrain_by_date></constrain_by_date>
</item>
</panel>
. . .
</filter_list>
<!-- output options -->
<output_option>
<patient_set select="using_filter_list" onlykeys="true"/>
<concept_set_using_filter_list select="using_filter_list" onlykeys="true"/>
<modifier_set_using_filter_list select="using_filter_list" onlykeys="true"/>
<observation_set blob="false" onlykeys="false"/>
<event_set select="using_filter_list" onlykeys="true"/>
<pid_set select="using_filter_list" onlykeys="true"/>
<eid_set select="using_filter_list" onlykeys="true"/>
<observer_set_using_filter_list onlykeys="true"/>
<!-- To specify generalized dimension type -->
<dimension_set_using_filter_list dimensionname="dimension1" onlykeys="true"/>
</output_option>
</crc:request>
<!-- response begin -->
<response>
<patient_data>
<!-- patient set section begins -->
<patient_set>
<patient>
<patient_id>patient_id6</patient_id>
<param column="vital_status_cd" type="string"
column_descriptor="date interpretation code"
name=" ">param3</param>
<param column="birth_date" type="dateTime"
column_descriptor="birthdate"
name="">param3</param>
<param column="death_date" type="dateTime"
column_descriptor="date of death">param3</param>
<param column="sex_cd" type="string"
column_descriptor="gender" name="">param3</param>
<param column="age_in_years_num" type="int"
column_descriptor="age">param3</param>
<param column="language_cd" type="string"
column_descriptor="language" name="">param3</param>
<param column="race_cd" type="string"
column_descriptor ="race" name="">param3</param>
<param column="religion_cd" type="string"
column_descriptor ="religion" name="">param3</param>
<param column="marital_status_cd" type="string"
column_descriptor ="marital status" name="">param3</param>
<param column="statecityzip_path_char" type="string"
column_descriptor="zip code hierarchy"
name="" >param3</param>
</patient>
. . .
</patient_set>
<!-- concept set section begins -->
<concept_set>
<concept>
<concept_path>concept_path0</concept_path>
<concept_cd>concept_cd0</concept_cd>
<name_char>name_char0</name_char>
</concept>
. . .
</concept_set>
<!-- observation set section begins -->
<observation_set panel_name="panel1">
<observation>
<event_id source="source3">event_id3</event_id>
<patient_id>patient_id9</patient_id>
<concept_cd name="name0">concept_cd3</concept_cd>
<observer_cd soruce="soruce0">observer_cd3</observer_cd>
<start_date>2006-05-04T18:13:51.0Z</start_date>
<modifier_cd name="name1">modifier_cd0</modifier_cd>
<instance_num>1</instance_num>
<valuetype_cd>valuetype_cd0</valuetype_cd>
<tval_char>tval_char0</tval_char>
<nval_num units="units0">3.141592653589</nval_num>
<valueflag_cd name="name2">valueflag_cd0</valueflag_cd>
<quantity_num>3.141592653589</quantity_num>
<units_cd>units_cd0</units_cd>
<end_date>2006-05-04T18:13:51.0Z</end_date>
<location_cd name="name3">location_cd0</location_cd>
</observation>
<observation>
. . .
</observation>
</observation_set>
<observation_set panel_name="panel2">
<observation>
. . .
</observation>
<observation>
. . .
</observation>
. . .
</observation_set>
<!-- event set section begins -->
<event_set>
<event>
<event_id source="source0">event_id0</event_id>
<patient_id>patient_id0</patient_id>
<start_date>2006-05-04T18:13:51.0Z</start_date>
<end_date>2006-05-04T18:13:51.0Z</end_date>
<param column="inout_cd" type="string" name=""
column_descriptor="in vs. outpatient code"></param>
<param column="location_cd" type="string" name=""
column_descriptor="location code"></param>
<param column="location_path" type="string" name=""
column_descriptor="location hierarchy"></param>
<param column="active_status_cd" type="string" name=""
column_descriptor="date interpretation code"></param>
</event>
. . .
</event_set>
<!-- observer / provider set section begins -->
<observer_set>
<observer>
<observer_path>observer_path0</observer_path>
<observer_cd>observer_cd0</observer_cd>
<name_char>name_char3</name_char>
</observer>
. . .
</observer_set>
<!-- pid set section begins -->
<pid_set>
<pid>
<patient_id status="A" source="HIVE">123456</patient_id>
</pid>
<pid>
<patient_id status="A" source="HIVE">234567</patient_id>
<patient_map_id status="A" source="EMP_E">ABC1</patient_map_id>
<patient_map_id status="A" source="MGH_E">XYZ1</patient_map_id>
</pid>
. . .
</pid_set>
</patient_data>
</response>
<!-- response end -->
</message_body>
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
This request returns the observation blob using the observation primary key.
Example:
<message_body>
<pdoheader>
<request_type>get_observationfact_by_primary_key</request_type>
</pdoheader>
<ns5:request xsi:type="ns5:GetObservationFactByPrimaryKey_requestType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<fact_primary_key>
<event_id>2004005981</event_id>
<patient_id>52003</patient_id>
<concept_cd>LCS-I2B2:c1009c</concept_cd>
<observer_id>03840261</observer_id>
<start_date>1995-08-24T00:00:00.179-05:00</start_date>
<instance_num>1</instance_num>
</fact_primary_key>
<fact_output_option select="using_filter_list" onlykeys="false"/>
</ns5:request>
<response>
<patient_data>
<observation_set>
<observation>
<event_id source="source3">event_id3</event_id>
<patient_id>patient_id9</patient_id>
<concept_cd name="name0">concept_cd3</concept_cd>
<observer_cd soruce="soruce0">observer_cd3</observer_cd>
<start_date>2006-05-04T18:13:51.0Z</start_date>
<instance_num>1</instance_num>
<observation_blob>
| Wiki Markup |
|---|
<!\[CDATA\[ |
patient notes]]>
</observation_blob>
</observation >
</observation_set>
</patient_data>
</response>
</message_body>
...
