Put Policy

put

https://example.com/patients/{patient_id}/policies/{policy_id}

Path Params

patient_id

integer

required

policy_id

integer

required

Body Params

address

length ≤ 200

Carrier street address

carrier_id

Insurance carrier identifier

carrier_name

length ≤ 200

Name of the insurance carrier

city

length ≤ 50

Carrier city

copay

length ≤ 19

Copay amount

county_code

length ≤ 10

Carrier county code

deductible

length ≤ 19

Deductible amount

end_date

Policy end date

extension

length ≤ 6

Carrier phone extension

group_id

length ≤ 50

Group identifier

Policy ID. If provided, updates the existing policy. If omitted, creates a new policy with a generated ID.

insured_person_address

length ≤ 200

Insured person's street address

insured_person_city

length ≤ 50

Insured person's city

insured_person_dob

Insured person's date of birth

insured_person_first_name

length ≤ 200

Insured person's first name

insured_person_id

length ≤ 50

Insured person's identifier

insured_person_last_name

length ≤ 200

Insured person's last name

insured_person_sex_at_birth

length ≤ 1

Insured person's sex at birth

insured_person_ssn

length ≤ 11

Insured person's SSN

insured_person_state

length ≤ 2

Insured person's state code

insured_person_zip

length ≤ 10

Insured person's ZIP code

medicare_secondary_code

length ≤ 5

Medicare secondary code

member_id

length ≤ 50

Member identifier

patient_dob

date

required

Patient's date of birth

patient_first_name

string

required

length ≤ 70

Patient's first name

patient_last_name

string

required

length ≤ 70

Patient's last name

payment_program

enum

Insurance payment program type

phone

length ≤ 20

Carrier phone number

plan_id

Insurance plan identifier

plan_name

length ≤ 200

Name of the insurance plan

rank

Policy rank (1=primary, 2=secondary, 3=tertiary)

relationship_to_insured

enum

Relationship of the patient to the insured person

start_date

Policy start date

state

length ≤ 2

Carrier state code

status

enum

Current status of the policy

suite

length ≤ 40

Carrier suite/unit number

vendor_company_id

For internal use only

vendor_external_id

length ≤ 100

For internal use only

zip

length ≤ 10

Carrier ZIP code

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error