---
title: "Create a Charge Capture from pre-encounter patient and appointment"
method: POST
path: "/api/charge_captures/v1/create-from-pre-encounter"
tags: ["v1"]
---

# Create a Charge Capture from pre-encounter patient and appointment

`POST /api/charge_captures/v1/create-from-pre-encounter`

Create a Charge Capture from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing
patients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage
of the pre-encounter service should use the standard create endpoint.

At encounter creation time, information from the provided patient and appointment objects will be populated
where applicable. In particular, the following fields are populated from the patient and appointment objects:
  - Patient
  - Referring Provider
  - Subscriber Primary
  - Subscriber Secondary
  - Referral Number
  - Responsible Party
  - Guarantor

Note that these fields should not be populated in the ChargeCaptureData property of this endpoint, as they will be overwritten at encounter creation time.

Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the
encounter has not already been submitted or adjudicated.

## Headers

- `Authorization` string, required

## Request body

- object
  - `data` V1ChargeCaptureData, required — unresolved $ref
  - `charge_external_id` string, required — A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.
  - `pre_encounter_patient_id` string, uuid, required
  - `pre_encounter_appointment_ids` TypeCommonsPreEncounterAppointmentId[], required
  - `originating_system` string — An optional string field denoting the originating system of the charge.
  - `claim_creation_category` string — An optional string field denoting the user defined category of the claim creation.
  - `ehr_source_url` string — External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123).
  - `status` V1ChargeCaptureStatus, required — unresolved $ref
  - `attachment_external_document_ids` string[] — Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time.
  - `hl7_message_type` V1Hl7MessageType — unresolved $ref

## Response `200`

Response with status 200

- V1ChargeCapture — unresolved $ref

## Other responses

- `403` — Error response with status 403
- `404` — Error response with status 404
- `409` — Error response with status 409
- `422` — Error response with status 422

---

[API](https://skmtc.net/joincandidhealth/apis/api-reference.md) · [All operations](https://skmtc.net/joincandidhealth/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/joincandidhealth/api-reference/revisions/7cc5974e4128/schema)