--- title: "Get All For Encounter" method: GET path: "/api/health-care-code-informations/v1/{encounter_id}" tags: ["v1"] --- # Get All For Encounter `GET /api/health-care-code-informations/v1/{encounter_id}` ## Request - Base URL: `https://pre-api.joincandidhealth.com` - URL: `https://pre-api.joincandidhealth.com/api/health-care-code-informations/v1/{encounter_id}` - Auth: HTTP bearer ## Path parameters - `encounter_id` string, uuid, required ## Response `200` Response with status 200 - HealthCareCodeInformationV1HealthCareCodeInformationGetAllResponse - `principal_diagnosis` HealthCareCodeInformationV1PrincipalDiagnosis: This corresponds to BK or ABK code qualifier values. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `principal_diagnosis_code_qualifier` 'BK' | 'ABK', required - `primary_diagnosis_code` string, required - `present_on_admission_indicator` 'Y' | 'N' | 'U' | 'W' | '1' - `other_diagnosis_information` HealthCareCodeInformationV1OtherDiagnosisInformation[], required - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `other_diagnosis_code_qualifier` 'BF' | 'ABF', required - `other_diagnosis` string, required - `present_on_admission_indicator` 'Y' | 'N' | 'U' | 'W' | '1' - `admitting_diagnosis` HealthCareCodeInformationV1AdmittingDiagnosis: This corresponds to BJ or ABJ code qualifier values. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `admitting_diagnosis_code_qualifier` 'BJ' | 'ABJ', required - `admitting_diagnosis_code` string, required - `patient_reasons_for_visit` HealthCareCodeInformationV1PatientReasonForVisit[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `patient_reason_for_visit_code_qualifier` 'PR' | 'APR', required - `patient_reason_for_visit` string, required - `external_causes_of_injury` HealthCareCodeInformationV1ExternalCauseOfInjury[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `external_cause_of_injury_code_qualifier` 'BN' | 'ABN', required - `external_cause_of_injury_code` string, required - `present_on_admission_indicator` 'Y' | 'N' | 'U' | 'W' | '1' - `diagnosis_related_groups` HealthCareCodeInformationV1DiagnosisRelatedGroup: This corresponds to DR code qualifier values. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `diagnosis_related_group_code_qualifier` 'DR', required - `diagnosis_related_group_code` string, required - `principal_procedure` HealthCareCodeInformationV1PrincipalProcedureInformation: This correspond to BBR, BR, and CAH code qualifier values. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `principal_procedure_code_qualifier` 'BBR' | 'BR' | 'CAH', required - `principal_procedure_code` string, required - `procedure_date` string, date, required - `other_procedure_information` HealthCareCodeInformationV1OtherProcedureInformation[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `other_procedure_code_qualifier` 'BBQ' | 'BQ', required - `other_procedure_code` string, required - `other_procedure_date` string, date, required - `occurrence_span_information` HealthCareCodeInformationV1OccurrenceSpanInformation[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `occurrence_span_code_qualifier` 'BI', required - `occurrence_span_code` '70' | '71' | '72' | '73' | '74' | '75' | '76' | '77' | '78' | '80' | '81' | '82' | 'M0' | 'M1' | 'M2' | 'M3' | 'M4', required - `occurrence_span_date` HealthCareCodeInformationV1RD8Date, required - `start` string, date, required - `end` string, date, required - `occurrence_information` HealthCareCodeInformationV1OccurrenceInformation[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `occurrence_code_qualifier` 'BH', required - `occurrence_code` '01' | '02' | '03' | '04' | '05' | '06' | '09' | '10' | '11' | '12' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '50' | '51' | '52' | '54' | '55' | '56' | '61' | '62' | 'A1' | 'A2' | 'A3' | 'A4' | 'B1' | 'B2' | 'B3' | 'C1' | 'C2' | 'C3', required - `occurrence_date` string, date, required - `treatment_code_information` HealthCareCodeInformationV1TreatmentCodeInformation[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `treatment_code_qualifier` 'TC', required - `treatment_code` string, required - `value_information` HealthCareCodeInformationV1ValueInformation[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `value_code_qualifier` 'BE', required - `value_code` '01' | '02' | '04' | '05' | '06' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '66' | '67' | '68' | '69' | '80' | '81' | '82' | '83' | '84' | '85' | '87' | '89' | '90' | '91' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6' | 'A7' | 'A8' | 'A9' | 'AA' | 'AB' | 'B1' | 'B2' | 'B3' | 'B7' | 'BA' | 'BB' | 'C1' | 'C2' | 'C3' | 'C7' | 'CA' | 'CB' | 'D3' | 'D4' | 'D5' | 'D6' | 'FC' | 'FD' | 'G8' | 'P1' | 'P2' | 'P3' | 'Y1' | 'Y2' | 'Y3' | 'Y4' | 'Y5', required - `value_code_amount` string, required: String representation of a Decimal that can be parsed by most libraries. - `condition_information` HealthCareCodeInformationV1ConditionInformation[], required: This object only applies to 837i institutional claim forms. - `id` string, uuid: The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter. - `encounter_id` string, uuid - `condition_code_qualifier` 'BG', required - `condition_code` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '46' | '47' | '48' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '59' | '60' | '61' | '66' | '67' | '68' | '69' | '70' | '71' | '72' | '73' | '74' | '75' | '76' | '77' | '78' | '79' | '80' | '81' | '82' | '83' | '84' | '85' | '86' | '87' | '88' | '89' | '90' | '91' | '92' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6' | 'A7' | 'A9' | 'AA' | 'AB' | 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AH' | 'AI' | 'AJ' | 'AK' | 'AL' | 'AM' | 'AN' | 'B0' | 'B1' | 'B2' | 'B3' | 'B4' | 'BP' | 'C1' | 'C2' | 'C3' | 'C4' | 'C5' | 'C6' | 'C7' | 'D0' | 'D1' | 'D2' | 'D3' | 'D4' | 'D5' | 'D6' | 'D7' | 'D8' | 'D9' | 'DR(a)' | 'E0' | 'G0' | 'H0' | 'H2' | 'H3' | 'H4' | 'H5' | 'P1' | 'P7' | 'R1' | 'R2' | 'R3' | 'R4' | 'R5' | 'R6' | 'R7' | 'R8' | 'R9' | 'W0' | 'W2' | 'W3' | 'W4' | 'W5', required: FL 18-28 - Condition Codes Source: UB-04 Manual 2025, Pages 64-81 (FL18-28, Pages 1-18) Excludes codes designated as "Payer Codes" or "FOR PUBLIC HEALTH DATA REPORTING ONLY" unless usage on claims is indicated. ## Other responses - `404`: Error response with status 404 ## Changes - **2026-09-17** `24b2d80d577a`: 1 breaking, 1 warning, 14 info - the response's body type changed from no type to `object` for status `200` - deleted the `header` request parameter `Authorization` - the endpoint scheme security `OAuthScheme` was added to the API - added the optional property `admitting_diagnosis` to the response with the `200` status - …12 more - **2026-09-12** `3a81ee81d4ed`: 1 info - api operation id `get_all_for_encounter` removed and replaced with `v1_get_all_for_encounter` [Operation history](https://skmtc.dev/joincandidhealth/apis/api-reference/changes/api/health-care-code-informations/v1/:encounter_id/get.md) --- [API](https://skmtc.dev/joincandidhealth/apis/api-reference.md) - [All operations](https://skmtc.dev/joincandidhealth/apis/api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/joincandidhealth/apis/api-reference/revisions/d8b0a61873e2?raw)