# Submit patient-reported health record intake Operation ID: `patient.submitPatientIntake` Additive intake for the authenticated patient. Each POST creates a new submission; repeated requests can create duplicate records. The server assigns all identifiers. Vendor status is separate from FHIR storage success. ## Public method `submitPatientIntake` Signature: `patient.submitPatientIntake(request)` Return type: `Promise` ## Authentication Classification: **AUTHENTICATED** Schemes: `bearerAuth` ## Prerequisites None documented. ## HTTP `POST /patients/health-record/intake` ## Path parameters None. ## Query parameters None. ## Body parameters | Name | Type | Required | Format | Allowed values | Default | Nullable | Description | |---|---|---:|---|---|---|---:|---| | `body` | [`PatientIntakeRequest`](../models/PatientIntakeRequest.md) | Yes | | | | No | | Request model: [`PatientIntakeRequest`](../models/PatientIntakeRequest.md) ## Request example ```json { "allergies": [ { "allergen": "string", "allergen_code": { "code": "string", "display": "string", "system": "string" }, "asserted_date": "2026-01-01", "category": "food", "criticality": "unable-to-assess", "intolerance_type": "allergy", "notes": "string", "onset_date": "2026-01-01", "reactions": [ { "manifestation": "string", "manifestation_code": { "code": "string", "display": "string" }, "notes": "string", "onset": "2026-01-01", "severity": "mild" } ], "resolved_date": "2026-01-01", "status": "active" } ], "cancer_cases": [ { "biomarkers": {}, "cancer_type": "string", "diagnosis_date": "2026-01-01", "diagnosis_method": "string", "grade": "string", "histology": "string", "histology_code": "string", "icd10_code": "string", "laterality": "not_applicable", "metastatic_sites": [ "string" ], "notes": "string", "primary_site": "string", "recurrence_date": "2026-01-01", "remission_date": "2026-01-01", "snomed_code": "string", "stage": "0", "subsite": "string", "tnm": { "clinical": true, "edition": "string", "m": "string", "n": "string", "t": "string" }, "treatments": [ { "description": "string", "end_date": "2026-01-01", "facility": "string", "modality": "surgery", "notes": "string", "provider_name": "string", "response": "string", "start_date": "2026-01-01", "status": "completed" } ] } ], "family_history": [ { "age_at_death": 0, "biological": true, "born_date": "2026-01-01", "cause_of_death": "string", "conditions": [ { "age_at_death": 0, "age_at_onset": 0, "condition": "string", "icd10_code": "string", "notes": "string", "snomed_code": "string" } ], "deceased": true, "member_name": "string", "notes": "string", "recorded_date": "2026-01-01", "relationship": "mother", "sex": "string", "status": "completed" } ], "gyn_history": [ { "cervical_screening_history": "string", "contraception": "string", "last_menstrual_period": "2026-01-01", "menarche_age": 0, "menopause_age": 0, "menstrual_history": "string", "notes": "string", "pregnancy_history": "string" } ], "medications": [ { "authored_on": "2026-01-01", "brand_name": "string", "discontinued_reason": "string", "dosage": { "duration_days": 1, "frequency": "once", "frequency_details": "string", "instructions": "string", "max_daily_dose": 0, "max_daily_dose_unit": "string", "unit": "string", "value": 1 }, "end_date": "2026-01-01", "generic_name": "string", "indication": "string", "name": "string", "ndc_code": "string", "notes": "string", "pharmacy": "string", "prescriber_name": "string", "refills_authorized": 0, "refills_remaining": 0, "route": "oral", "rxnorm_code": "string", "start_date": "2026-01-01", "status": "active" } ], "perinatal_history": [ { "delivery_date": "2026-01-01", "delivery_method": "string", "gestational_age_weeks": 0, "maternal_complications": "string", "neonatal_complications": "string", "notes": "string", "outcome": "string", "pregnancy_year": 1900 } ], "problems": [ { "asserted_date": "2026-01-01", "body_site": "string", "categories": [ "problem-list-item" ], "clinical_status": "active", "description": "string", "icd10_code": "string", "laterality": "string", "notes": "string", "onset_age": 0, "onset_date": "2026-01-01", "recorded_date": "2026-01-01T09:00:00Z", "resolved_date": "2026-01-01", "severity": "mild", "snomed_code": "string" } ], "social_history": [ { "alcohol": { "binge_drinking": true, "drinks_per_week": 0, "frequency": "unknown", "notes": "string" }, "contraception": "string", "diet_category": "carbohydrate", "diet_description": "string", "education": "less_than_high_school", "employer": "string", "exercise_frequency": "sedentary", "exercise_minutes_per_week": 0, "gender_identity": "man", "living_situation": "alone", "notes": "string", "number_of_dependents": 0, "occupation": "string", "occupational_exposures": [ "string" ], "sexual_orientation": "heterosexual", "sexually_active": true, "substances": [ { "frequency": "string", "notes": "string", "quit_year": 0, "route": "string", "start_year": 0, "status": "unknown", "substance": "string" } ], "tobacco": { "cessation_aids": "string", "cigarettes_per_day": 0, "pack_years": 0, "quit_year": 0, "start_year": 0, "status": "unknown" }, "travel_history": [ "string" ] } ], "surgical_history": [ { "anesthesia_type": "string", "body_sites": [ "string" ], "complications": [ "string" ], "cpt_code": "string", "description": "string", "facility": "string", "indication": "string", "laterality": "left", "notes": "string", "outcome": "string", "performed_date": "2026-01-01", "performed_date_end": "2026-01-01", "performer_name": "string", "snomed_code": "string", "status": "completed" } ], "vaccines": [ { "administered_by": "string", "administered_date": "2026-01-01", "administered_datetime": "2026-01-01T09:00:00Z", "cvx_code": "string", "dose_number": 1, "dose_quantity": 0, "dose_unit": "string", "expiration_date": "2026-01-01", "lot_number": "string", "manufacturer": "string", "mvx_code": "string", "not_done_reason": "string", "notes": "string", "reactions": [ { "notes": "string", "onset_date": "2026-01-01", "reaction": "string", "severity": "mild" } ], "reason_codes": [ "string" ], "route": "intramuscular", "series_doses": 1, "series_name": "string", "site": "left_deltoid", "status": "completed", "vaccine_name": "string", "vis_document_date": "2026-01-01" } ] } ``` ## Success responses | Status | Shape | Content type | Description | |---|---|---|---| | `200` | [`PatientIntakeResponse`](../models/PatientIntakeResponse.md) | application/json | Durable intake and per-section vendor delivery status | ## Success response examples ### 200 ```json { "created_at": "2026-01-01T09:00:00Z", "invalid_entries": {}, "storage_status": "pending", "submission_id": "00000000-0000-0000-0000-000000000000", "unknown_fields": [ "string" ], "vendors": {} } ``` ## Common errors None declared in canonical OpenAPI. ## Error examples None declared in canonical OpenAPI. ## NodeJS / TypeScript implementation ```ts import { HCSDK } from "@healthcloudai/hc-sdk"; ``` ```ts const request = { "allergies": [ { "allergen": "string", "allergen_code": { "code": "string", "display": "string", "system": "string" }, "asserted_date": "2026-01-01", "category": "food", "criticality": "unable-to-assess", "intolerance_type": "allergy", "notes": "string", "onset_date": "2026-01-01", "reactions": [ { "manifestation": "string", "manifestation_code": { "code": "string", "display": "string" }, "notes": "string", "onset": "2026-01-01", "severity": "mild" } ], "resolved_date": "2026-01-01", "status": "active" } ], "cancer_cases": [ { "biomarkers": {}, "cancer_type": "string", "diagnosis_date": "2026-01-01", "diagnosis_method": "string", "grade": "string", "histology": "string", "histology_code": "string", "icd10_code": "string", "laterality": "not_applicable", "metastatic_sites": [ "string" ], "notes": "string", "primary_site": "string", "recurrence_date": "2026-01-01", "remission_date": "2026-01-01", "snomed_code": "string", "stage": "0", "subsite": "string", "tnm": { "clinical": true, "edition": "string", "m": "string", "n": "string", "t": "string" }, "treatments": [ { "description": "string", "end_date": "2026-01-01", "facility": "string", "modality": "surgery", "notes": "string", "provider_name": "string", "response": "string", "start_date": "2026-01-01", "status": "completed" } ] } ], "family_history": [ { "age_at_death": 0, "biological": true, "born_date": "2026-01-01", "cause_of_death": "string", "conditions": [ { "age_at_death": 0, "age_at_onset": 0, "condition": "string", "icd10_code": "string", "notes": "string", "snomed_code": "string" } ], "deceased": true, "member_name": "string", "notes": "string", "recorded_date": "2026-01-01", "relationship": "mother", "sex": "string", "status": "completed" } ], "gyn_history": [ { "cervical_screening_history": "string", "contraception": "string", "last_menstrual_period": "2026-01-01", "menarche_age": 0, "menopause_age": 0, "menstrual_history": "string", "notes": "string", "pregnancy_history": "string" } ], "medications": [ { "authored_on": "2026-01-01", "brand_name": "string", "discontinued_reason": "string", "dosage": { "duration_days": 1, "frequency": "once", "frequency_details": "string", "instructions": "string", "max_daily_dose": 0, "max_daily_dose_unit": "string", "unit": "string", "value": 1 }, "end_date": "2026-01-01", "generic_name": "string", "indication": "string", "name": "string", "ndc_code": "string", "notes": "string", "pharmacy": "string", "prescriber_name": "string", "refills_authorized": 0, "refills_remaining": 0, "route": "oral", "rxnorm_code": "string", "start_date": "2026-01-01", "status": "active" } ], "perinatal_history": [ { "delivery_date": "2026-01-01", "delivery_method": "string", "gestational_age_weeks": 0, "maternal_complications": "string", "neonatal_complications": "string", "notes": "string", "outcome": "string", "pregnancy_year": 1900 } ], "problems": [ { "asserted_date": "2026-01-01", "body_site": "string", "categories": [ "problem-list-item" ], "clinical_status": "active", "description": "string", "icd10_code": "string", "laterality": "string", "notes": "string", "onset_age": 0, "onset_date": "2026-01-01", "recorded_date": "2026-01-01T09:00:00Z", "resolved_date": "2026-01-01", "severity": "mild", "snomed_code": "string" } ], "social_history": [ { "alcohol": { "binge_drinking": true, "drinks_per_week": 0, "frequency": "unknown", "notes": "string" }, "contraception": "string", "diet_category": "carbohydrate", "diet_description": "string", "education": "less_than_high_school", "employer": "string", "exercise_frequency": "sedentary", "exercise_minutes_per_week": 0, "gender_identity": "man", "living_situation": "alone", "notes": "string", "number_of_dependents": 0, "occupation": "string", "occupational_exposures": [ "string" ], "sexual_orientation": "heterosexual", "sexually_active": true, "substances": [ { "frequency": "string", "notes": "string", "quit_year": 0, "route": "string", "start_year": 0, "status": "unknown", "substance": "string" } ], "tobacco": { "cessation_aids": "string", "cigarettes_per_day": 0, "pack_years": 0, "quit_year": 0, "start_year": 0, "status": "unknown" }, "travel_history": [ "string" ] } ], "surgical_history": [ { "anesthesia_type": "string", "body_sites": [ "string" ], "complications": [ "string" ], "cpt_code": "string", "description": "string", "facility": "string", "indication": "string", "laterality": "left", "notes": "string", "outcome": "string", "performed_date": "2026-01-01", "performed_date_end": "2026-01-01", "performer_name": "string", "snomed_code": "string", "status": "completed" } ], "vaccines": [ { "administered_by": "string", "administered_date": "2026-01-01", "administered_datetime": "2026-01-01T09:00:00Z", "cvx_code": "string", "dose_number": 1, "dose_quantity": 0, "dose_unit": "string", "expiration_date": "2026-01-01", "lot_number": "string", "manufacturer": "string", "mvx_code": "string", "not_done_reason": "string", "notes": "string", "reactions": [ { "notes": "string", "onset_date": "2026-01-01", "reaction": "string", "severity": "mild" } ], "reason_codes": [ "string" ], "route": "intramuscular", "series_doses": 1, "series_name": "string", "site": "left_deltoid", "status": "completed", "vaccine_name": "string", "vis_document_date": "2026-01-01" } ] }; const result = await patient.submitPatientIntake(request); ``` ## cURL ```bash curl -X POST \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{"allergies":[{"allergen":"string","allergen_code":{"code":"string","display":"string","system":"string"},"asserted_date":"2026-01-01","category":"food","criticality":"unable-to-assess","intolerance_type":"allergy","notes":"string","onset_date":"2026-01-01","reactions":[{"manifestation":"string","manifestation_code":{"code":"string","display":"string"},"notes":"string","onset":"2026-01-01","severity":"mild"}],"resolved_date":"2026-01-01","status":"active"}],"cancer_cases":[{"biomarkers":{},"cancer_type":"string","diagnosis_date":"2026-01-01","diagnosis_method":"string","grade":"string","histology":"string","histology_code":"string","icd10_code":"string","laterality":"not_applicable","metastatic_sites":["string"],"notes":"string","primary_site":"string","recurrence_date":"2026-01-01","remission_date":"2026-01-01","snomed_code":"string","stage":"0","subsite":"string","tnm":{"clinical":true,"edition":"string","m":"string","n":"string","t":"string"},"treatments":[{"description":"string","end_date":"2026-01-01","facility":"string","modality":"surgery","notes":"string","provider_name":"string","response":"string","start_date":"2026-01-01","status":"completed"}]}],"family_history":[{"age_at_death":0,"biological":true,"born_date":"2026-01-01","cause_of_death":"string","conditions":[{"age_at_death":0,"age_at_onset":0,"condition":"string","icd10_code":"string","notes":"string","snomed_code":"string"}],"deceased":true,"member_name":"string","notes":"string","recorded_date":"2026-01-01","relationship":"mother","sex":"string","status":"completed"}],"gyn_history":[{"cervical_screening_history":"string","contraception":"string","last_menstrual_period":"2026-01-01","menarche_age":0,"menopause_age":0,"menstrual_history":"string","notes":"string","pregnancy_history":"string"}],"medications":[{"authored_on":"2026-01-01","brand_name":"string","discontinued_reason":"string","dosage":{"duration_days":1,"frequency":"once","frequency_details":"string","instructions":"string","max_daily_dose":0,"max_daily_dose_unit":"string","unit":"string","value":1},"end_date":"2026-01-01","generic_name":"string","indication":"string","name":"string","ndc_code":"string","notes":"string","pharmacy":"string","prescriber_name":"string","refills_authorized":0,"refills_remaining":0,"route":"oral","rxnorm_code":"string","start_date":"2026-01-01","status":"active"}],"perinatal_history":[{"delivery_date":"2026-01-01","delivery_method":"string","gestational_age_weeks":0,"maternal_complications":"string","neonatal_complications":"string","notes":"string","outcome":"string","pregnancy_year":1900}],"problems":[{"asserted_date":"2026-01-01","body_site":"string","categories":["problem-list-item"],"clinical_status":"active","description":"string","icd10_code":"string","laterality":"string","notes":"string","onset_age":0,"onset_date":"2026-01-01","recorded_date":"2026-01-01T09:00:00Z","resolved_date":"2026-01-01","severity":"mild","snomed_code":"string"}],"social_history":[{"alcohol":{"binge_drinking":true,"drinks_per_week":0,"frequency":"unknown","notes":"string"},"contraception":"string","diet_category":"carbohydrate","diet_description":"string","education":"less_than_high_school","employer":"string","exercise_frequency":"sedentary","exercise_minutes_per_week":0,"gender_identity":"man","living_situation":"alone","notes":"string","number_of_dependents":0,"occupation":"string","occupational_exposures":["string"],"sexual_orientation":"heterosexual","sexually_active":true,"substances":[{"frequency":"string","notes":"string","quit_year":0,"route":"string","start_year":0,"status":"unknown","substance":"string"}],"tobacco":{"cessation_aids":"string","cigarettes_per_day":0,"pack_years":0,"quit_year":0,"start_year":0,"status":"unknown"},"travel_history":["string"]}],"surgical_history":[{"anesthesia_type":"string","body_sites":["string"],"complications":["string"],"cpt_code":"string","description":"string","facility":"string","indication":"string","laterality":"left","notes":"string","outcome":"string","performed_date":"2026-01-01","performed_date_end":"2026-01-01","performer_name":"string","snomed_code":"string","status":"completed"}],"vaccines":[{"administered_by":"string","administered_date":"2026-01-01","administered_datetime":"2026-01-01T09:00:00Z","cvx_code":"string","dose_number":1,"dose_quantity":0,"dose_unit":"string","expiration_date":"2026-01-01","lot_number":"string","manufacturer":"string","mvx_code":"string","not_done_reason":"string","notes":"string","reactions":[{"notes":"string","onset_date":"2026-01-01","reaction":"string","severity":"mild"}],"reason_codes":["string"],"route":"intramuscular","series_doses":1,"series_name":"string","site":"left_deltoid","status":"completed","vaccine_name":"string","vis_document_date":"2026-01-01"}]}' \ 'https://dev-api-patient.health.cloud/patients/health-record/intake' ``` ## Notes None. ## Prepared Test Console scenario No canonical scenario is currently associated. ## Real response No approved real integration response is currently published. Unapproved candidates are never rendered as examples.