v2

Create Professional or Institutional Service Line

Changed on
post/api/service-lines/v2/universal

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/service-lines/v2/universal
  • Auth
    HTTP bearer

Request body

modifiersCommonsProcedureModifier[]
charge_amount_centsinteger

The total amount charged for this service line, factoring in quantity. The system will attempt to set it based on the chargemaster configuration and the service line’s quantity. For example, if a single unit has an entry of 100 cents and 2 units were rendered, the charge_amount_cents will be set to 200. If there is no chargemaster entry, the system will default to the amount set via this field.

place_of_service_code'01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '31' | '32' | '33' | '34' | '41' | '42' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '60' | '61' | '62' | '65' | '71' | '72' | '81' | '99'

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set

quantitystring required

String representation of a Decimal that can be parsed by most libraries.

units'MJ' | 'UN' required
claim_idstring uuid required
descriptionstring

A free-form description to clarify the related data elements and their content. Maps to SV1-01, C003-07 on a 837-P and SV2-02, C003-07 on a 837-I form.

date_of_servicestring date
end_date_of_servicestring date
has_epsdt_indicatorboolean

Maps to SV1-11 on the 837-P and Box 24H on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.

has_family_planning_indicatorboolean

Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.

notestring

Maps to NTE02 loop 2400 on the EDI 837.

diagnosis_id_zerostring uuid
diagnosis_id_onestring uuid
diagnosis_id_twostring uuid
diagnosis_id_threestring uuid
custom_procedure_codestring

Represents and preserves the custom CPT code received on this service line. Custom CPT codes are specific to your organization and are primarily used for rules and reporting purposes.

revenue_codestring

A 4 digit code that specifies facility department or type of service arrangement for institutional service line items (837i). This code is not required for professional claim billing (837p).

procedure_codestring nullable

Pass null to create the service line as uncoded, which is valid for institutional (837i) claims that bill by revenue code rather than a CPT/HCPCS code.

prior_authorization_numberstring

Prior authorization number for this service line. Maps to the appropriate REF segment on Loop 2400 of the EDI 837p. This is not used for institutional claims (EDI 837i).

external_idstring

An external identifier for this service line. This is not used in the EDI 837, but can be used to identify the service line in external systems. This field should not contain PHI. Must be unique on a given claim.

Response

Response with status 200

created_atstring date-time required
modifiersCommonsProcedureModifier[]
charge_amount_centsinteger
allowed_amount_centsinteger
insurance_balance_centsinteger
patient_balance_centsinteger
paid_amount_centsinteger
primary_paid_amount_centsinteger
secondary_paid_amount_centsinteger
tertiary_paid_amount_centsinteger
patient_responsibility_centsinteger
copay_centsinteger
coinsurance_centsinteger
deductible_centsinteger
diagnosis_id_zerostring uuid
diagnosis_id_onestring uuid
diagnosis_id_twostring uuid
diagnosis_id_threestring uuid
place_of_service_code'01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '31' | '32' | '33' | '34' | '41' | '42' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '60' | '61' | '62' | '65' | '71' | '72' | '81' | '99'

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set

place_of_service_code_as_submitted'01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '31' | '32' | '33' | '34' | '41' | '42' | '49' | '50' | '51' | '52' | '53' | '54' | '55' | '56' | '57' | '58' | '60' | '61' | '62' | '65' | '71' | '72' | '81' | '99'

Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set

service_line_idstring uuid required
procedure_codestring required
custom_procedure_codestring

Represents and preserves the custom CPT code received on this service line. Custom CPT codes are specific to your organization and are used for rules and reporting purposes.

revenue_codestring

A 4 digit code that specifies facility department or type of service arrangement for institutional service line items (837i). This code is not required for professional claim billing (837p).

quantitystring required

String representation of a Decimal that can be parsed by most libraries.

units'MJ' | 'UN' required
claim_idstring uuid required
descriptionstring

A free-form description to clarify the related data elements and their content. Maps to SV1-01, C003-07 on a 837-P and SV2-02, C003-07 on a 837-I form.

date_of_servicestring date required
end_date_of_servicestring date
has_epsdt_indicatorboolean

Maps to SV1-11 on the 837-P and Box 24H on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.

has_family_planning_indicatorboolean

Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.

notestring

Maps to NTE02 loop 2400 on the EDI 837.

prior_authorization_numberstring

Prior authorization number for this service line. Maps to the appropriate REF segment on Loop 2400 of the EDI 837p. This is not used for institutional claims (EDI 837i).

external_idstring

An external identifier for this service line. This is not used in the EDI 837, but can be used to identify the service line in external systems. This field should not contain PHI. Must be unique on a given claim.

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • warning

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

    • warning

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

    • info

      added the new WC enum value to the request property /

    • info

      added the new WH enum value to the request property /