JOjoincandidhealth
v1

Create Encounter Attachment V2

Changed on

Uploads a file to the encounter. The file will be stored in the encounter's attachments.

put/api/encounter-attachments/v1/{encounter_id}/v2

Request

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

Path parameters

encounter_idstring uuid required

Request body multipart/form-data

attachment_filestring binary required

The file for upload. The maximum file size is 25MB. The allowed mime types are:

  • application/pdf
  • image/png
  • image/jpeg
  • text/plain
  • text/csv
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
attachment_type'APPEAL_LETTER' | 'CERTIFICATION' | 'CONSENT_FORM' | 'DOCUMENTATION' | 'EOB' | 'JUSTIFICATION_OF_ADMISSION' | 'LABORATORY_RESULTS' | 'MEDICAL_RECORD_ATTACHMENT' | 'OPERATIVE_NOTE' | 'OTHER' | 'PHYSICAL_THERAPY_NOTE' | 'REFERRAL_FORM' | 'SUPPORT_DATA_FOR_CLAIM' required
descriptionstring

Response

Response with status 200

string uuid required

Changes

  • 97de8fddb088Revision changes
    • info

      added the new APPEAL_LETTER enum value to the request property

    • info

      added the new CERTIFICATION enum value to the request property

    • info

      added the new CONSENT_FORM enum value to the request property

    • info

      added the new JUSTIFICATION_OF_ADMISSION enum value to the request property

    • info

      added the new LABORATORY_RESULTS enum value to the request property

    • info

      added the new MEDICAL_RECORD_ATTACHMENT enum value to the request property

    • info

      added the new OPERATIVE_NOTE enum value to the request property

    • info

      added the new PHYSICAL_THERAPY_NOTE enum value to the request property

    • info

      added the new REFERRAL_FORM enum value to the request property

    • info

      added the new SUPPORT_DATA_FOR_CLAIM enum value to the request property

  • 24b2d80d577aRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the response's body type changed from no type to string, and format from no format to uuid for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new DOCUMENTATION enum value to the request property

    • info

      added the new EOB enum value to the request property

    • info

      added the new OTHER enum value to the request property

    • info

      the request property type was generalized from no type to string