Elation Import API

{"openapi":"3.0.1","info":{"description":"This set of API resources allows you to import patient data into the Elation\nEMR.  For more information on Elation APIs, view [our\ndocumentation](https://docs.elationhealth.com/reference).\n\nThe expected flow for an import is:\n1. Create a Data Import Request for each batch of imports. There is no size limit on an import batch, though larger batches will take longer to process. You may separate your imports into batches using whatever logic you like. Each batch must be for a single practice and a single provider within that practice.\n\n2. Create Patient Chart Import Requests for each chart you want to import. Some validation will occur at create time, but final validation only occurs when the import is attempted. Patient Chart Import Requests are initially created in the `open` status.\n\n3. When you are ready to begin importing data, update the Patient Chart Import Request status to `pending`. It will not be imported immediately, but it will be added to the queue.  \n\n4. Alternatively, a convenience is provided at the Data Import Request level. POSTing to `/data-import-request/{dir-id}/run` will transition all child Patient Chart Import Requests in `open` to `pending`.\n\n5. Check the status of the import by polling the Data Import Request item. If import failures occur, you can review the Patient Chart Import Requests that failed and then update and rerun them individually.\n\n6. Once all Patient Chart Import Requests have succeeded, you should consider the Data Import Request to be successful. Please review your data within the web application to ensure that charts imported as you expected.\n\nIf you encounter any problems, please contact Elation at api-support@elationhealth.com.","version":"1.0.2","title":"Elation Import API","termsOfService":"https://www.elationhealth.com/terms-of-use/","contact":{"email":"api-support@elationhealth.com"}},"tags":[{"name":"Data Import Request","description":"The parent resource for tracking batches of individual patient chart imports."}],"paths":{"/data-import-requests":{"get":{"tags":["Data Import Request"],"summary":"Retrieve a list of existing data import requests.","description":"","operationId":"getDIRs","responses":{"200":{"description":"An array of Data Import Request details without statuses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataImportRequestArray"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"}},"security":[{"elation_auth":["import"]}]},"post":{"tags":["Data Import Request"],"summary":"Create a new data import request.","description":"","operationId":"createDIR","responses":{"200":{"description":"Details of the created Data Import Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistingDataImportRequest"}}}},"201":{"description":"New Data Import Request successfully created; check Location reponse header"},"400":{"description":"Validation error(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"422":{"description":"The request body could not be parsed as JSON"}},"security":[{"elation_auth":["import"]}],"requestBody":{"$ref":"#/components/requestBodies/CreateDataImportRequest"}}},"/data-import-requests/{dir-id}":{"parameters":[{"in":"path","name":"dir-id","required":true,"schema":{"type":"integer","format":"int64"},"description":"The id of the existing Data Import Request"}],"get":{"tags":["Data Import Request"],"summary":"Retrieve an existing data import request.","description":"This can be used to check on the status of all child Patient Chart Import Requests.","operationId":"getDIR","responses":{"200":{"description":"Details of the Data Import Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistingDataImportRequest"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"404":{"description":"Existing Data Import Request not found"}},"security":[{"elation_auth":["import"]}]},"put":{"tags":["Data Import Request"],"summary":"Update an existing data import request.","description":"All editable fields must be included even if the value is unchanged.","operationId":"updateDIR","responses":{"200":{"description":"Details of the updated Data Import Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistingDataImportRequest"}}}},"400":{"description":"Validation error(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"404":{"description":"Existing Data Import Request not found"},"422":{"description":"The request body could not be parsed as JSON"}},"security":[{"elation_auth":["import"]}],"requestBody":{"$ref":"#/components/requestBodies/ExistingDataImportRequest"}},"patch":{"tags":["Data Import Request"],"summary":"Update an existing data import request.","description":"Only include fields where the value is changing.","operationId":"patchDIR","responses":{"400":{"description":"Validation error(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"404":{"description":"Existing Data Import Request not found"},"422":{"description":"The request body could not be parsed as JSON"}},"security":[{"elation_auth":["import"]}],"requestBody":{"$ref":"#/components/requestBodies/ExistingDataImportRequest"}},"delete":{"tags":["Data Import Request"],"summary":"Delete an existing data import request.","description":"Only possible if no Patient Chart Import Requests have ever been created for this Data Import Request.","operationId":"deleteDIR","responses":{"401":{"description":"No valid credentials provided"},"403":{"description":"The Data Import Request cannot be deleted because child records already exist; or your credentials are not authorized to use the import API resources"},"404":{"description":"Existing Data Import Request not found"}},"security":[{"elation_auth":["import"]}]}},"/data-import-requests/{dir-id}/run":{"parameters":[{"in":"path","name":"dir-id","required":true,"schema":{"type":"integer","format":"int64"},"description":"The id of the existing Data Import Request"}],"post":{"tags":["Data Import Request"],"summary":"Convenience call","description":"Convenience call to transition all child Patient Chart Import Requests in `open` to `pending`","operationId":"runDIR","responses":{"202":{"description":"Request accepted; Patient Chart Import Requests will be updated"},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"}},"security":[{"elation_auth":["import"]}]}},"/data-import-requests/{dir-id}/patient-chart-imports":{"parameters":[{"name":"dir-id","in":"path","description":"ID of the data-import-request","required":true,"schema":{"type":"integer"}}],"get":{"tags":["patient chart import"],"summary":"Finds patient_chart_import records by status","description":"Multiple status values can be provided with comma separated strings","operationId":"findchartsByStatus","parameters":[{"name":"status","in":"query","description":"Status values that need to be considered for filter","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","default":"open","enum":["open","pending","processing","failed","completed"]}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatientChartInputGetList"}},"example":[{"id":10,"patientId":11,"dataImportRequestId":12,"completedAt":12341234123,"errors":null,"sectionStatus":[],"status":"open","startedProcessingAt":null}]}}},"400":{"description":"Invalid status value","content":{}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"404":{"description":"Data Import Request not found"}},"security":[{"elation_auth":["import"]}]},"post":{"tags":["patient chart import"],"summary":"Add a new patient-chart-import to the associated data import request","operationId":"addchart","requestBody":{"description":"patient-chart-import object that needs to be added to the DIR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientChartInputPost"}}},"required":true},"responses":{"400":{"description":"Validation error(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"404":{"description":"Existing Data Import Request not found"},"422":{"description":"The request body could not be parsed as JSON"}},"security":[{"elation_auth":["import"]}]}},"/data-import-requests/{dir-id}/patient-chart-imports/{pci-id}":{"parameters":[{"name":"dir-id","in":"path","description":"ID of the data-import-request","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"pci-id","in":"path","description":"ID of patient-chart-import to return","required":true,"schema":{"type":"integer","format":"int64"}}],"get":{"tags":["patient chart import"],"summary":"Find patient-chart-import by ID","description":"Returns a single patient-chart-import","operationId":"getPatientChartImportById","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientChartInputGetId"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"404":{"description":"Data Import Request or Patient Chart Import not found","content":{}}},"security":[{"elation_auth":["import"]}]},"put":{"tags":["patient chart import"],"summary":"Update an existing patient-chart-import","operationId":"updatepatient-chart-import","requestBody":{"description":"patient-chart-import object that needs to be added to the DIR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientChartInputPut"}}},"required":true},"responses":{"400":{"description":"Validation error(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"401":{"description":"No valid credentials provided"},"403":{"description":"Your credentials are not authorized to use the import API resources"},"404":{"description":"Data Import Request or Patient Chart Import not found","content":{}},"422":{"description":"The request body could not be parsed as JSON"}},"security":[{"elation_auth":["import"]}]},"patch":{"tags":["patient chart import"],"summary":"Updates a patient-chart-import in the store with form data","operationId":"updatepatient-chart-importWithForm","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"Updated name of the patient-chart-import"},"status":{"$ref":"#/components/schemas/JobStatus"}}}}}},"responses":{"400":{"description":"Validation error(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"405":{"description":"Invalid input","content":{}}},"security":[{"elation_auth":["import"]}]},"delete":{"tags":["patient chart import"],"summary":"Deletes a patient-chart-import","operationId":"deletepatient-chart-import","responses":{"401":{"description":"No valid credentials provided"},"403":{"description":"Patient Chart Import is in a state where it cannot be deleted; or your credentials are not authorized to use the import API resources"},"404":{"description":"Data Import Request or Patient Chart Import not found","content":{}}},"security":[{"elation_auth":["import"]}]}},"/data-import-requests/{dir-id}/patient-chart-imports/{pci-id}/render-requests":{"parameters":[{"name":"dir-id","in":"path","description":"ID of data-import-request to update","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"pci-id","in":"path","description":"ID of patient-chart-import to update","required":true,"schema":{"type":"integer","format":"int64"}}],"post":{"tags":["patient chart import"],"summary":"uploads an document for rendering","operationId":"uploadFile","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"additionalMetadata":{"type":"string","description":"Additional data to pass to server"},"file":{"type":"string","description":"file to upload","format":"binary"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse"}}}},"400":{"description":"Validation error(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"404":{"description":"Data Import Request or Patient Chart Import not found","content":{}}},"security":[{"elation_auth":["import"]}]}}},"externalDocs":{"description":"Elation API v2 Documentation","url":"https://docs.elationhealth.com/reference"},"components":{"requestBodies":{"CreateDataImportRequest":{"description":"Data Import Request object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDataImportRequest"}}}},"ExistingDataImportRequest":{"description":"Data Import Request object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExistingDataImportRequest"}}}}},"securitySchemes":{"elation_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"http://www.elationhealth.com/api/2.0/oauth","refreshUrl":"http://www.elationhealth.com/api/2.0/oauth","scopes":{"import":"interact with data imports in your practice"}}}}},"schemas":{"PatientChartInputPut":{"required":["chart_json","status"],"type":"object","properties":{"patient_id":{"type":"integer","format":"int64","description":"read-only, Only set after import has occurred"},"chart_json":{"$ref":"#/components/schemas/ChartBuilderJson"},"status":{"$ref":"#/components/schemas/JobStatus"}}},"PatientChartInputPost":{"required":["chart_json","status"],"type":"object","properties":{"source_patient_id":{"type":"string","description":"a patient key, normally (fname|lname|dob|gender)"},"chart_json":{"$ref":"#/components/schemas/ChartBuilderJson"},"status":{"$ref":"#/components/schemas/JobStatus"}}},"PatientChartInputGetList":{"required":["chart_json","status"],"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"read-only"},"patient_id":{"type":"integer","format":"int64","description":"read-only, Only set after import has occurred"},"data_import_request_id":{"type":"integer","format":"int64","description":"read-only after initial creation"},"completed_at":{"type":"integer","format":"date-time","description":"unix UTC timestamp"},"errors":{"type":"array","items":{"type":"object","format":"json","description":"List of field/message tuples describing the issues with the latest attempt to import the associated chart_json"}},"section_status":{"type":"object","description":"TBD.  Some object that indicates which sections of the chart were successfully imported and which failed."},"status":{"$ref":"#/components/schemas/JobStatus"},"started_processing_at":{"type":"string","format":"date-time","description":"(iso8601) datetime. read-only"}}},"PatientChartInputGetId":{"allOf":[{"$ref":"#/components/schemas/PatientChartInputGetList"},{"type":"object"}],"properties":{"chart_json":{"$ref":"#/components/schemas/ChartBuilderJson"}}},"ApiResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"type":{"type":"string"},"message":{"type":"string"}}},"JobStatus":{"type":"string","default":"open","description":"The current status of the patient chart import. Options are open, pending, processing, failed, completed","enum":["open","pending","processing","failed","completed"]},"BaseDataImportRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true,"description":"The id of the Data Import Request"},"created_at":{"type":"string","format":"date-time","readOnly":true,"description":"The creation timestamp for the Data Import Request"},"notes":{"type":"string","description":"Arbitrary notes to associate with the Data Import Request"}}},"ExistingDataImportRequestWithoutStatus":{"required":["id","created_at","physician_id","practice_id","sections_to_import"],"allOf":[{"$ref":"#/components/schemas/BaseDataImportRequest"},{"type":"object"}],"properties":{"physician_id":{"type":"integer","format":"int64","readOnly":true,"description":"The id of the physician provider to import all child patient charts for; cannot be updated after initial create"},"practice_id":{"type":"integer","format":"int64","readOnly":true,"description":"The id of the practice to import all child patient charts for; cannot be updated after initial create"}}},"ExistingDataImportRequest":{"required":["id","created_at","physician_id","practice_id","sections_to_import","status"],"allOf":[{"$ref":"#/components/schemas/ExistingDataImportRequestWithoutStatus"},{"type":"object"}],"properties":{"status":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"importStatus":{"$ref":"#/components/schemas/JobStatus"},"numPatientImports":{"type":"integer","format":"int32","description":"The number of child Patient Chart Import Requests in the associated status"}}}}}},"CreateDataImportRequest":{"required":["physician_id","practice_id","sections_to_import"],"allOf":[{"$ref":"#/components/schemas/BaseDataImportRequest"},{"type":"object"}],"properties":{"physician_id":{"type":"integer","format":"int64","description":"The id of the physician provider to import all child patient charts for; cannot be updated after initial create"},"practice_id":{"type":"integer","format":"int64","description":"The id of the practice to import all child patient charts for; cannot be updated after initial create"}}},"DataImportRequestArray":{"type":"array","items":{"$ref":"#/components/schemas/ExistingDataImportRequestWithoutStatus"}},"ValidationErrorResponse":{"type":"object","additionalProperties":{"description":"Name of the field with validation errors","type":"array","items":{"type":"string","description":"Validation error string"}}},"ChartBuilderJson":{"description":"contains JSON schema that describes the json that chart_builder.py consumes to create chart. Schemas are uploaded to a public s3 endpoint that is backing http://data-import.elationemr.com. The files are stored in the /spec/ folder.","type":"object"},"genericJsonBlob":{"type":"object","additionalProperties":{"type":"string"}},"allergy":{"oneOf":[{"type":"object","properties":{"nkda":{"type":"boolean"}},"required":["nkda"],"additionalProperties":false},{"type":"object","properties":{"rxnorm_cui":{"type":"string","maxLength":128},"medispandnid":{"type":"string","description":"Medispan DNID","maxLength":32},"allergen_name":{"type":"string","maxLength":255,"minLength":1},"status":{"type":"string","enum":["Active","Inactive"]},"start_date":{"$ref":"#/components/schemas/demographic/properties/dob"},"reaction":{"type":"string","maxLength":200}},"required":["allergen_name"],"additionalProperties":false}]},"appointment":{"type":"object","properties":{"appointment_time":{"$ref":"#/components/schemas/med_order/properties/chart_date"},"description":{"type":"string","maxLength":255},"duration":{"type":"integer"},"physician_id":{"type":"integer"},"appointment_type":{"type":"string","maxLength":50,"minLength":1},"status":{"type":"string","maxLength":50,"enum":["scheduled","confirmed","checkedIn","inRoom","vitalsTaken","withDr","checkedOut","billed","notSeen","cancelled"]}},"required":["appointment_time","duration","appointment_type"],"additionalProperties":false},"demographic":{"properties":{"first_name":{"type":"string","maxLength":70,"minLength":1},"middle_name":{"type":"string","maxLength":50},"last_name":{"type":"string","maxLength":70,"minLength":1},"dob":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"gender":{"type":"string","enum":["M","F","N"]},"primary_practice_provider_id":{"description":"Should map to a provider in the patient's practice","type":"integer"},"primary_practice_provider":{"type":"object","properties":{"first_name":{"type":"string","maxLength":70},"last_name":{"type":"string","maxLength":70}},"required":["first_name","last_name"],"additionalProperties":false},"caregiver_practice_id":{"type":"integer"},"patient_notes":{"type":"string","maxLength":500},"email":{"type":"string","maxLength":75},"ssn":{"type":"string","maxLength":9},"race":{"type":"string","enum":["No race specified","American Indian or Alaska Native","Asian","Black or African American","Native Hawaiian or Other Pacific Islander","White","Declined to specify"]},"ethnicity":{"type":"string","enum":["No ethnicity specified","Hispanic or Latino","Not Hispanic or Latino","Declined to specify"]},"language":{"type":"string","enum":["Abkhazian","Afar","Afrikaans","Akan","Albanian","Amharic","Arabic","Aragonese","Armenian","Assamese","Avaric","Avestan","Aymara","Azerbaijani","Bambara","Bashkir","Basque","Belarusian","Bengali","Bihari languages","Bislama","Bokmål, Norwegian; Norwegian Bokmål","Bosnian","Breton","Bulgarian","Burmese","Catalan; Valencian","Central Khmer","Chamorro","Chechen","Chichewa; Chewa; Nyanja","Chinese - Cantonese","Chinese - Mandarin","Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic","Chuvash","Cornish","Corsican","Cree","Croatian","Czech","Danish","Declined to specify","Divehi; Dhivehi; Maldivian","Dutch; Flemish","Dzongkha","English","Esperanto","Estonian","Ewe","Faroese","Fijian","Finnish","French","Fulah","Gaelic; Scottish Gaelic","Galician","Ganda","Georgian","German","Greek, Modern (1453-)","Guarani","Gujarati","Haitian; Haitian Creole","Hausa","Hebrew","Herero","Hindi","Hiri Motu","Hungarian","Icelandic","Ido","Igbo","Indonesian","Interlingua (International Auxiliary Language Association)","Interlingue; Occidental","Inuktitut","Inupiaq","Irish","Italian","Japanese","Javanese","Kalaallisut; Greenlandic","Kannada","Kanuri","Kashmiri","Kazakh","Kikuyu; Gikuyu","Kinyarwanda","Kirghiz; Kyrgyz","Komi","Kongo","Korean","Kuanyama; Kwanyama","Kurdish","Lao","Latin","Latvian","Limburgan; Limburger; Limburgish","Lingala","Lithuanian","Luba-Katanga","Luxembourgish; Letzeburgesch","Macedonian","Malagasy","Malay","Malayalam","Maltese","Manx","Maori","Marathi","Marshallese","Mongolian","Nauru","Navajo; Navaho","Ndebele, North; North Ndebele","Ndebele, South; South Ndebele","Ndonga","Nepali","Northern Sami","Norwegian","Norwegian Nynorsk; Nynorsk, Norwegian","Occitan (post 1500)","Ojibwa","Oriya","Oromo","Ossetian; Ossetic","Other","Pali","Panjabi; Punjabi","Persian","Polish","Portuguese","Pushto; Pashto","Quechua","Romanian; Moldavian; Moldovan","Romansh","Rundi","Russian","Samoan","Sango","Sanskrit","Sardinian","Serbian","Shona","Sichuan Yi; Nuosu","Sindhi","Sinhala; Sinhalese","Slovak","Slovenian","Somali","Sotho, Southern","Spanish; Castilian","Sundanese","Swahili","Swati","Swedish","Tagalog","Tahitian","Tajik","Tamil","Tatar","Telugu","Thai","Tibetan","Tigrinya","Tonga (Tonga Islands)","Tsonga","Tswana","Turkish","Turkmen","Twi","Uighur; Uyghur","Ukrainian","Urdu","Uzbek","Venda","Vietnamese","Volapük","Walloon","Welsh","Western Frisian","Wolof","Xhosa","Yiddish","Yoruba","Zhuang; Chuang","Zulu"]},"address":{"type":"object","properties":{"address_line1":{"type":"string","maxLength":200},"address_line2":{"type":"string","maxLength":35},"city":{"type":"string","maxLength":50},"state":{"type":"string","maxLength":2},"zip":{"type":"string","maxLength":10}},"additionalProperties":false},"insurances":{"description":"The first insurance in the list will be considered the primary.","type":"array","items":{"type":"object","properties":{"carrier":{"type":"string","maxLength":200,"minLength":1},"member_id":{"type":"string","maxLength":50,"minLength":1},"group_id":{"type":"string","maxLength":50,"minLength":1},"carrier_phone":{"type":"string","maxLength":20},"carrier_phone_ext":{"type":"string","maxLength":6},"copay":{"type":"number"},"deductible":{"type":"number"},"insured_person_name":{"type":"string","maxLength":200},"insured_person_address":{"type":"string","maxLength":200},"insured_person_city":{"type":"string","maxLength":50},"insured_person_state":{"type":"string","maxLength":2},"insured_person_zip":{"type":"string","maxLength":10},"relationship_to_insured":{"type":"string","enum":["child","spouse","other"]},"insured_person_dob":{"$ref":"#/components/schemas/demographic/properties/dob"},"insured_person_gender":{"type":"string","enum":["M","F","N"]},"insured_person_ssn":{"type":"string","maxLength":11},"payment_program":{"type":"string","maxLength":50}},"required":["carrier","member_id","group_id"],"additionalProperties":false},"maxItems":2},"phones":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","pattern":"^[0-9]{10}$"},"phone_type":{"type":"string","enum":["Cell Phone","Home","Main","Work","Night","Fax","Other"]}},"required":["phone","phone_type"],"additionalProperties":false},"maxItems":2},"preferred_pharmacy_ncpdp_id_1":{"type":"string","maxLength":21},"preferred_pharmacy_ncpdp_id_2":{"type":"string","maxLength":21},"chart_number":{"description":"External Chart ID.  Userful to link external (source) chart to Elation chart","type":"string","maxLength":50,"minLength":1},"employer":{"type":"object","properties":{"code":{"type":"string","maxLength":50},"name":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255}},"required":["code"],"additionalProperties":false},"patient_tags":{"type":"array","items":{"type":"string","maxLength":100}},"metadata":{"description":"Metadata is useful for storing additional, structured information on an object that is only visible to your API 2.0 application. This section should only be filled out if an API 2.0 integration is already set up","type":"object","properties":{"object_id":{"description":"ID of your choice. An example would be an ID in another system that represents the same patient.","type":"string","maxLength":100},"data":{"description":"Structured information related to the patient for API purposes. This information does not show up in the patient chart in Elation.","type":"object"}}},"el8_patient_id":{"type":"integer","description":"Should only be used for follow-up imports. This is the Elation ID for the patient so we can safely update the correct patient without doing a demographics match."}},"required":["first_name","last_name","dob","gender","chart_number"],"additionalProperties":false},"history_item":{"type":"object","properties":{"text":{"type":"string","maxLength":500}},"required":["text"],"additionalProperties":false},"family_history_item":{"type":"object","properties":{"relationship":{"type":"string","enum":["Mother","Father","Brother","Sister","Son","Daughter","Grandmother","Grandfather","Aunt","Uncle","Other"]},"text":{"type":"string","maxLength":500}},"required":["relationship","text"],"additionalProperties":false},"smoking_status_item":{"type":"object","properties":{"smoking_status":{"type":"string","enum":["Current every day smoker","Current some day smoker","Former smoker","Never smoker","Smoker, current status unknown","Light tobacco smoker","Heavy tobacco smoker","Unknown if ever smoked"]},"as_of_date":{"$ref":"#/components/schemas/demographic/properties/dob"}},"required":["smoking_status","as_of_date"],"additionalProperties":false},"history_items":{"type":"array","items":{"$ref":"#/components/schemas/history_item"}},"family_history_items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/history_item"},{"$ref":"#/components/schemas/family_history_item"}]}},"habit_history_items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/history_item"},{"$ref":"#/components/schemas/smoking_status_item"}]}},"history_item_map":{"type":"object","properties":{"Past":{"$ref":"#/components/schemas/history_items"},"Family":{"$ref":"#/components/schemas/family_history_items"},"Social":{"$ref":"#/components/schemas/history_items"},"Habits":{"$ref":"#/components/schemas/habit_history_items"},"Diet":{"$ref":"#/components/schemas/history_items"},"Exercise":{"$ref":"#/components/schemas/history_items"},"Immunization":{"$ref":"#/components/schemas/history_items"},"Legal":{"$ref":"#/components/schemas/history_items"},"Consultation":{"$ref":"#/components/schemas/history_items"},"Maintenance":{"$ref":"#/components/schemas/history_items"},"Surgical":{"$ref":"#/components/schemas/history_items"},"Cognitive":{"$ref":"#/components/schemas/history_items"},"Functional":{"$ref":"#/components/schemas/history_items"}},"additionalProperties":false},"immunization":{"type":"object","properties":{"administering_physician_id":{"type":"integer"},"vaccine":{"type":"string","maxLength":70,"minLength":1},"cvx":{"type":"integer"},"administered_date":{"$ref":"#/components/schemas/demographic/properties/dob"},"qty":{"type":"number"},"qty_units":{"type":"string","maxLength":100},"expiration_date":{"$ref":"#/components/schemas/demographic/properties/dob"},"method":{"type":"string","maxLength":50},"site":{"type":"string","maxLength":100},"reason":{"type":"string","maxLength":255},"notes":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255},"lot_number":{"type":"string","maxLength":100},"manufacturer_name":{"type":"string","maxLength":50},"manufacturer_code":{"type":"string","maxLength":20}},"required":["cvx","vaccine"],"additionalProperties":false},"immunization_decline":{"type":"object","properties":{"cdc_type":{"type":"string","maxLength":20,"minLength":1},"declined_date":{"$ref":"#/components/schemas/demographic/properties/dob"},"declined_reason":{"type":"string","maxLength":255},"immunity":{"type":"boolean"}},"required":["cdc_type","declined_date"],"additionalProperties":false},"problem":{"type":"object","properties":{"icd9_codes":{"type":"array","items":{"type":"string","maxLength":50}},"icd10_codes":{"type":"array","items":{"type":"string","maxLength":50}},"snomed_codes":{"type":"array","items":{"type":"string","maxLength":50}},"description":{"type":"string","maxLength":200,"minLength":1},"start_date":{"$ref":"#/components/schemas/demographic/properties/dob"},"status":{"type":"string","enum":["Active","Controlled","Resolved"]},"details":{"type":"string","maxLength":500},"resolved_date":{"$ref":"#/components/schemas/demographic/properties/dob"}},"required":["description","start_date","status"],"additionalProperties":false},"lab_result":{"type":"object","properties":{"lab_test_code":{"type":"string","maxLength":50},"lab_test_name":{"type":"string","maxLength":255},"lab_test_loinc":{"type":"string","maxLength":50},"test_category_code":{"type":"string","maxLength":50},"test_category_description":{"type":"string","maxLength":200},"reference_min":{"type":"string","maxLength":50},"reference_max":{"type":"string","maxLength":50},"value":{"type":"string","maxLength":500},"value_type":{"type":"string","maxLength":20},"units":{"type":"string","maxLength":20},"is_abnormal":{"type":"boolean"},"abnormal_flag":{"type":"string","enum":["L","H","LL","HH","<",">","N","A","AA","PS","NG","IN","U","D","B","W","S","R","I","MS","VS"]},"status":{"type":"string","enum":["C","D","F","I","P","R","S","U","X","E","A"]}},"required":["lab_test_code","lab_test_name","test_category_code","test_category_description","value","units"],"additionalProperties":false},"lab_result_panel":{"type":"object","properties":{"collection_date":{"$ref":"#/components/schemas/med_order/properties/chart_date"},"accession_number":{"type":"string","maxLength":100},"resulted_date":{"$ref":"#/components/schemas/med_order/properties/chart_date"},"status":{"type":"string","maxLength":20},"lab_report_note":{"type":"string","maxLength":1000},"lab_results":{"type":"array","items":{"$ref":"#/components/schemas/lab_result"}}},"required":["lab_results","accession_number","resulted_date","status","collection_date"],"additionalProperties":false},"lab_report":{"type":"object","properties":{"chart_date":{"$ref":"#/co

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/openapi/elation-elation-import-api.json