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

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: Created

[{&quot;lineage&quot;:&quot;\u003cstring\u003e&quot;,&quot;admit_source&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;batch_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient_class&quot;:&quot;\u003cstring\u003e&quot;,&quot;recorded_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_payments&quot;:&quot;\u003cnumber\u003e&quot;,&quot;rating&quot;:&quot;\u003cstring\u003e&quot;,&quot;admission_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;account_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;discharge_disposition&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;xc_visit_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_charges&quot;:&quot;\u003cnumber\u003e&quot;,&quot;ambulatory_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;preadmit_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;preadmit_test_indicator&quot;:&quot;\u003cstring\u003e&quot;,&quot;alternate_visit_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;admit_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;encounter_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;visit_indicator&quot;:&quot;\u003cstring\u003e&quot;,&quot;bed_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;bedside_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;discharge_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;servicing_facility&quot;:&quot;\u003cstring\u003e&quot;,&quot;diet_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;message_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;discharged_to_location&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_adjustments&quot;:&quot;\u003cnumber\u003e&quot;,&quot;visit_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;hospital_service&quot;:&quot;\u003cstring\u003e&quot;,&quot;financial_class&quot;:&quot;\u003cstring\u003e&quot;,&quot;readmission_indicator&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;bundle_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;current_patient_balance&quot;:&quot;\u003cnumber\u003e&quot;,&quot;facility&quot;:&quot;\u003cstring\u003e&quot;,&quot;insurance&quot;:[{&quot;insurance_company_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;insurance_company_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type_code&quot;:&quot;\u003cstring\u003e&quot;},{&quot;insurance_company_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;insurance_company_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type_code&quot;:&quot;\u003cstring\u003e&quot;}],&quot;providers&quot;:[{&quot;provider_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;report_grouper_twelve&quot;:&quot;\u003cstring\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;prov_cred&quot;:&quot;\u003cstring\u003e&quot;},{&quot;provider_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;report_grouper_twelve&quot;:&quot;\u003cstring\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;prov_cred&quot;:&quot;\u003cstring\u003e&quot;}],&quot;facilities&quot;:[{&quot;bed&quot;:&quot;\u003cstring\u003e&quot;,&quot;point_of_care&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;room&quot;:&quot;\u003cstring\u003e&quot;},{&quot;bed&quot;:&quot;\u003cstring\u003e&quot;,&quot;point_of_care&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;room&quot;:&quot;\u003cstring\u003e&quot;}]},{&quot;lineage&quot;:&quot;\u003cstring\u003e&quot;,&quot;admit_source&quot;:&quot;\u003cstring\u003e&quot;,&quot;reason&quot;:&quot;\u003cstring\u003e&quot;,&quot;batch_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient_class&quot;:&quot;\u003cstring\u003e&quot;,&quot;recorded_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_payments&quot;:&quot;\u003cnumber\u003e&quot;,&quot;rating&quot;:&quot;\u003cstring\u003e&quot;,&quot;admission_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;account_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;discharge_disposition&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;xc_visit_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_charges&quot;:&quot;\u003cnumber\u003e&quot;,&quot;ambulatory_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;preadmit_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;preadmit_test_indicator&quot;:&quot;\u003cstring\u003e&quot;,&quot;alternate_visit_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;admit_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;encounter_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;visit_indicator&quot;:&quot;\u003cstring\u003e&quot;,&quot;bed_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;bedside_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;discharge_datetime&quot;:&quot;\u003cstring\u003e&quot;,&quot;servicing_facility&quot;:&quot;\u003cstring\u003e&quot;,&quot;diet_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;message_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;discharged_to_location&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_adjustments&quot;:&quot;\u003cnumber\u003e&quot;,&quot;visit_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;hospital_service&quot;:&quot;\u003cstring\u003e&quot;,&quot;financial_class&quot;:&quot;\u003cstring\u003e&quot;,&quot;readmission_indicator&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;bundle_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;current_patient_balance&quot;:&quot;\u003cnumber\u003e&quot;,&quot;facility&quot;:&quot;\u003cstring\u003e&quot;,&quot;insurance&quot;:[{&quot;insurance_company_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;insurance_company_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type_code&quot;:&quot;\u003cstring\u003e&quot;},{&quot;insurance_company_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;insurance_company_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_type_code&quot;:&quot;\u003cstring\u003e&quot;}],&quot;providers&quot;:[{&quot;provider_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;report_grouper_twelve&quot;:&quot;\u003cstring\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;prov_cred&quot;:&quot;\u003cstring\u003e&quot;},{&quot;provider_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;report_grouper_twelve&quot;:&quot;\u003cstring\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;prov_cred&quot;:&quot;\u003cstring\u003e&quot;}],&quot;facilities&quot;:[{&quot;bed&quot;:&quot;\u003cstring\u003e&quot;,&quot;point_of_care&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;room&quot;:&quot;\u003cstring\u003e&quot;},{&quot;bed&quot;:&quot;\u003cstring\u003e&quot;,&quot;point_of_care&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;facility_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;room&quot;:&quot;\u003cstring\u003e&quot;}]}]