JOjoincandidhealth
v1

Get Encounter Supplemental Information

Changed on
get/api/encounter-supplemental-information/v1/{encounter_id}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/encounter-supplemental-information/v1/{encounter_id}
  • Auth
    HTTP bearer

Path parameters

encounter_idstring uuid required

Response

Response with status 200

supplemental_information_idstring uuid required
attachment_idstring uuid
attachment_report_type_code'03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '13' | '15' | '21' | 'A3' | 'A4' | 'AM' | 'AS' | 'B2' | 'B3' | 'B4' | 'BR' | 'BS' | 'BT' | 'CB' | 'CK' | 'CT' | 'D2' | 'DA' | 'DB' | 'DG' | 'DJ' | 'DS' | 'EB' | 'HC' | 'HR' | 'I5' | 'IR' | 'LA' | 'M1' | 'MT' | 'NN' | 'OB' | 'OC' | 'OD' | 'OE' | 'OX' | 'OZ' | 'P4' | 'P5' | 'PE' | 'PN' | 'PO' | 'PQ' | 'PY' | 'PZ' | 'RB' | 'RR' | 'RT' | 'RX' | 'SG' | 'V5' | 'XP' required
attachment_transmission_code'AA' | 'BM' | 'EL' | 'FX' required
attachment_control_numberstring
attachment_inclusion'not_included' | 'included_on_next_submission' | 'included_on_all_submissions' required
encounter_idstring uuid required

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id get removed and replaced with v1_get_15