action drchrono_patient_vaccine_records_read { label: "patient_vaccine_records_read" description: "Retrieve an existing patient vaccine records" provider: drchrono method: GET path: "/api/patient_vaccine_records/{id}" encoding: json input: { type: "object" properties: { cvx_code: { type: "string" } doctor: { type: "integer" } id: { type: "string" } patient: { type: "integer" } since: { type: "string" } } required: ["id"] additionalProperties: false } output: { type: "object" required: ["cvx_code", "name", "patient"] properties: { administered_at: { type: "integer" description: "ID of `/api/offices` where the administration happened" } administered_by: { type: "string" description: "ID of `/api/users` who performs the administration" } administration_start: { type: "string" description: "Datetime when the administration starts" } amount: { type: "number" description: "Amount of vaccine administered" } comments: { type: "string" } completion_status: { type: "string" description: "Vaccination status, can be `CP`(Complete), `RE`(Refused), `NA`(Not administered), `PA`(Partially administered)" enum: ["CP", "RE", "NA", "PA"] } consent_form: { type: "integer" description: "Consent form related with vaccine record" } cpt_code: { type: "string" description: "Vaccine cpt code" } created_at: { type: "string" } cvx_code: { type: "string" description: "Vaccine cvx code" } doses: { type: "array" description: "Vaccine dose IDs received in consent form signed hook" items: { type: "object" description: "Vaccine dose ID" properties: { id: { type: "integer" } max_age_months: { type: "integer" } min_age_months: { type: "integer" } title: { type: "string" } } } } entered_by: { type: "string" description: "ID of user who created the record" } funding_eligibility: { type: "string" description: "The funding program that should pay for a given immunization" enum: ["V01", "V02", "V03", "V04", "V05", "V07"] } id: { type: "integer" } name: { type: "string" } next_dose_date: { type: "string" description: "Date for next dose of vaccine" } observed_immunity: { type: "string" enum: ["398102009", "409498004", "397428000", "18624000", "91428005", "271511000", "240532009", "6142004", "52947006", "14189004", "23511006", "36989005", "27836007", "16814004", "14168008", "36653000", "76902006", "66071002", "4834000", "111852003", "38907003", "40468003", "16541001"] } ordering_doctor: { type: "integer" } patient: { type: "integer" } record_source: { type: "string" enum: ["00", "01", "02", "03", "04", "05", "06", "07", "08"] } route: { type: "string" } site: { type: "string" } units: { type: "string" } updated_at: { type: "string" } vaccine_inventory: { type: "integer" description: "ID of `/api/vaccine_inventories` the vaccine is from" } vis: { type: "string" description: "Related vaccine information statement" } } } }