JOjoincandidhealth
v1

Create a Charge Capture from pre-encounter patient and appointment

Changed on

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.

post/api/charge_captures/v1/create-from-pre-encounter

Request

Request body

charge_external_idstring 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_idstring uuid required
pre_encounter_appointment_idsCommonsPreEncounterAppointmentId[] required
originating_systemstring

An optional string field denoting the originating system of the charge.

claim_creation_categorystring

An optional string field denoting the user defined category of the claim creation.

ehr_source_urlstring

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'planned' | 'not-billable' | 'billable' | 'aborted' | 'entered-in-error' required
attachment_external_document_idsstring[]

Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time.

hl7_message_type'BAR' | 'DFT' | 'ADT'

HL7 message type that produced a charge-capture write. Values match the bare MSH-9-1 code emitted by HL7 producers (conduit). Constrains the hl7_message_type field on charge-capture create/update payloads so that whitespace, case drift, or non-canonical values are rejected at the API boundary instead of silently bypassing the BAR/DFT discriminator.

Response

Response with status 200

idstring uuid required
status'planned' | 'not-billable' | 'billable' | 'aborted' | 'entered-in-error' required
date_of_servicestring date
patient_external_idstring required
charge_external_idstring required
ehr_source_urlstring
originating_systemstring
claim_creation_categorystring
claim_creation_idstring uuid

Changes

  • 40f62949c810Revision changes
    • warning

      added the new 65 enum value to the //// response property for the response status

    • warning

      added the new AC enum value to the //// response property for the response status

    • warning

      added the new BG enum value to the //// response property for the response status

    • warning

      added the new DR enum value to the //// response property for the response status

    • warning

      added the new DX enum value to the //// response property for the response status

    • warning

      added the new MR enum value to the //// response property for the response status

    • warning

      added the new OH enum value to the //// response property for the response status

    • warning

      added the new TZ enum value to the //// response property for the response status

    • info

      added the new 65 enum value to the request property ////

    • info

      added the new AC enum value to the request property ////

    • info

      added the new BG enum value to the request property ////

    • info

      added the new DR enum value to the request property ////

    • info

      added the new DX enum value to the request property ////

    • info

      added the new MR enum value to the request property ////

    • info

      added the new OH enum value to the request property ////

    • info

      added the new TZ enum value to the request property ////

  • d8b0a61873e2Revision changes
    • info

      added the new optional request property ///

    • info

      added the optional property /// to the response with the status