Skip to main content
GET
Retrieve Immunization Decline

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
/api/2.0/oauth2/token/

Path Parameters

id
integer<int64>
required

Response

200 - application/json
cdc_type
string
required
Maximum string length: 100
declined_date
string<date-time>
required
patient
integer<int64>
required
created_date
string<date-time> | null
read-only
cvx
integer | null
read-only

The CVX code of the vaccine. Set it through vaccine.

declined_reason
enum<string> | null

Why the patient declined the immunization.

Available options:
Other (must add text component of the CE field with description),
Parental decision,
Patient decision,
Religious exemption
deleted_date
string<date-time> | null
read-only
id
integer
read-only
immunity
boolean

Whether the patient declined due to existing immunity. When true, declined_reason is null.

practice
integer<int64> | null
vaccine
object | null
vaccine_name
string | null
read-only