Encounter States
POST {{baseUrl}}/get_encounter_states/execute
This function will return the cumulative state of the encounter (based on alternatevisitnumber or interaction id or encounter id) at a given time (based on interaction id or encounter id or end date. It will make use of the information received in the selective set of HL7 messages.
Request Body
{"interaction_id"=>"<string>", "encounter_id"=>"<string>", "alternate_visit_number"=>"<string>", "start_date"=>"<string>", "end_date"=>"<string>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Authorization | string |
RESPONSES
status: Created
[{"lineage":"\u003cstring\u003e","admit_source":"\u003cstring\u003e","reason":"\u003cstring\u003e","batch_id":"\u003cstring\u003e","patient_class":"\u003cstring\u003e","recorded_datetime":"\u003cstring\u003e","total_payments":"\u003cnumber\u003e","rating":"\u003cstring\u003e","admission_type":"\u003cstring\u003e","account_status":"\u003cstring\u003e","discharge_disposition":"\u003cstring\u003e","type":"\u003cstring\u003e","xc_visit_id":"\u003cstring\u003e","total_charges":"\u003cnumber\u003e","ambulatory_status":"\u003cstring\u003e","datetime":"\u003cstring\u003e","patient_type":"\u003cstring\u003e","preadmit_number":"\u003cstring\u003e","preadmit_test_indicator":"\u003cstring\u003e","alternate_visit_id":"\u003cstring\u003e","admit_datetime":"\u003cstring\u003e","encounter_id":"\u003cstring\u003e","visit_indicator":"\u003cstring\u003e","bed_status":"\u003cstring\u003e","bedside_datetime":"\u003cstring\u003e","discharge_datetime":"\u003cstring\u003e","servicing_facility":"\u003cstring\u003e","diet_type":"\u003cstring\u003e","message_type":"\u003cstring\u003e","discharged_to_location":"\u003cstring\u003e","total_adjustments":"\u003cnumber\u003e","visit_number":"\u003cstring\u003e","hospital_service":"\u003cstring\u003e","financial_class":"\u003cstring\u003e","readmission_indicator":"\u003cstring\u003e","patient_id":"\u003cstring\u003e","bundle_id":"\u003cstring\u003e","current_patient_balance":"\u003cnumber\u003e","facility":"\u003cstring\u003e","insurance":[{"insurance_company_id":"\u003cstring\u003e","insurance_company_name":"\u003cstring\u003e","id_type":"\u003cstring\u003e","id_type_code":"\u003cstring\u003e"},{"insurance_company_id":"\u003cstring\u003e","insurance_company_name":"\u003cstring\u003e","id_type":"\u003cstring\u003e","id_type_code":"\u003cstring\u003e"}],"providers":[{"provider_type":"\u003cstring\u003e","report_grouper_twelve":"\u003cstring\u003e","provider_id":"\u003cstring\u003e","prov_cred":"\u003cstring\u003e"},{"provider_type":"\u003cstring\u003e","report_grouper_twelve":"\u003cstring\u003e","provider_id":"\u003cstring\u003e","prov_cred":"\u003cstring\u003e"}],"facilities":[{"bed":"\u003cstring\u003e","point_of_care":"\u003cstring\u003e","facility_type":"\u003cstring\u003e","facility_code":"\u003cstring\u003e","room":"\u003cstring\u003e"},{"bed":"\u003cstring\u003e","point_of_care":"\u003cstring\u003e","facility_type":"\u003cstring\u003e","facility_code":"\u003cstring\u003e","room":"\u003cstring\u003e"}]},{"lineage":"\u003cstring\u003e","admit_source":"\u003cstring\u003e","reason":"\u003cstring\u003e","batch_id":"\u003cstring\u003e","patient_class":"\u003cstring\u003e","recorded_datetime":"\u003cstring\u003e","total_payments":"\u003cnumber\u003e","rating":"\u003cstring\u003e","admission_type":"\u003cstring\u003e","account_status":"\u003cstring\u003e","discharge_disposition":"\u003cstring\u003e","type":"\u003cstring\u003e","xc_visit_id":"\u003cstring\u003e","total_charges":"\u003cnumber\u003e","ambulatory_status":"\u003cstring\u003e","datetime":"\u003cstring\u003e","patient_type":"\u003cstring\u003e","preadmit_number":"\u003cstring\u003e","preadmit_test_indicator":"\u003cstring\u003e","alternate_visit_id":"\u003cstring\u003e","admit_datetime":"\u003cstring\u003e","encounter_id":"\u003cstring\u003e","visit_indicator":"\u003cstring\u003e","bed_status":"\u003cstring\u003e","bedside_datetime":"\u003cstring\u003e","discharge_datetime":"\u003cstring\u003e","servicing_facility":"\u003cstring\u003e","diet_type":"\u003cstring\u003e","message_type":"\u003cstring\u003e","discharged_to_location":"\u003cstring\u003e","total_adjustments":"\u003cnumber\u003e","visit_number":"\u003cstring\u003e","hospital_service":"\u003cstring\u003e","financial_class":"\u003cstring\u003e","readmission_indicator":"\u003cstring\u003e","patient_id":"\u003cstring\u003e","bundle_id":"\u003cstring\u003e","current_patient_balance":"\u003cnumber\u003e","facility":"\u003cstring\u003e","insurance":[{"insurance_company_id":"\u003cstring\u003e","insurance_company_name":"\u003cstring\u003e","id_type":"\u003cstring\u003e","id_type_code":"\u003cstring\u003e"},{"insurance_company_id":"\u003cstring\u003e","insurance_company_name":"\u003cstring\u003e","id_type":"\u003cstring\u003e","id_type_code":"\u003cstring\u003e"}],"providers":[{"provider_type":"\u003cstring\u003e","report_grouper_twelve":"\u003cstring\u003e","provider_id":"\u003cstring\u003e","prov_cred":"\u003cstring\u003e"},{"provider_type":"\u003cstring\u003e","report_grouper_twelve":"\u003cstring\u003e","provider_id":"\u003cstring\u003e","prov_cred":"\u003cstring\u003e"}],"facilities":[{"bed":"\u003cstring\u003e","point_of_care":"\u003cstring\u003e","facility_type":"\u003cstring\u003e","facility_code":"\u003cstring\u003e","room":"\u003cstring\u003e"},{"bed":"\u003cstring\u003e","point_of_care":"\u003cstring\u003e","facility_type":"\u003cstring\u003e","facility_code":"\u003cstring\u003e","room":"\u003cstring\u003e"}]}]