Elation Visit Notes API
Create, retrieve, and manage clinical visit notes and their documentation, including note signing, via the Elation API v2.0.
Create, retrieve, and manage clinical visit notes and their documentation, including note signing, via the Elation API v2.0.
{"openapi":"3.1.0","info":{"title":"Visit Notes API","description":"This API supports the management of visit notes.","version":"0.1.0"},"servers":[{"url":"https://sandbox.elationemr.com/api/2.0","description":"Sandbox Environment"}],"paths":{"/notes":{"get":{"description":"Returns a paginated list of note metadata","operationId":"list_notes","parameters":[{"description":"Limit for pagination","in":"query","name":"limit","required":false,"schema":{"default":20,"description":"Limit for pagination","maximum":100,"minimum":1,"title":"Limit","type":"integer"}},{"description":"Offset for pagination","in":"query","name":"offset","required":false,"schema":{"default":0,"description":"Offset for pagination","title":"Offset","type":"integer"}},{"description":"Filter by practice ID","in":"query","name":"practice_id","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by practice ID","title":"Practice Id"}},{"description":"True to filter to draft notes only. False to include only signed notes. Omit to include both.","in":"query","name":"is_draft","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"True to filter to draft notes only. False to include only signed notes. Omit to include both.","title":"Is Draft"}},{"description":"Filter by patient ID","in":"query","name":"patient","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by patient ID","title":"Patient"}},{"description":"Comma separated list of provider IDs","in":"query","name":"providers","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma separated list of provider IDs","title":"Providers"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_NoteMetadata_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"List Notes","tags":["Notes"]},"post":{"description":"Create a new `Note`.","operationId":"create_note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Create Note","tags":["Notes"]}},"/notes/custom-blocks":{"get":{"operationId":"list_custom_blocks","parameters":[{"description":"Limit for pagination","in":"query","name":"limit","required":false,"schema":{"default":20,"description":"Limit for pagination","maximum":100,"minimum":1,"title":"Limit","type":"integer"}},{"description":"Offset for pagination","in":"query","name":"offset","required":false,"schema":{"default":0,"description":"Offset for pagination","title":"Offset","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_CustomBlockResponse_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":["apiv2"]}],"summary":"List Custom Blocks","tags":["Custom Blocks"]}},"/notes/{note_id}":{"delete":{"description":"Delete a specific draft note","operationId":"delete_note_by_id","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"204":{"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Delete Note By Id","tags":["Notes"]},"get":{"description":"Get a specific note. Returns a sections-based response for layout notes,\nor a legacy Note for notes created before the sections schema.\n\nThis endpoint fetches a note without creating a snapshot. The snapshot is used for conflict\nresolution when multiple sources are concurrently updating the note.\n\nTo fetch a note for editing that requires conflict resolution, use the `/notes/{note_id}/edit`\nendpoint instead.","operationId":"get_note_by_id","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ElationNote"},{"$ref":"#/components/schemas/Note"}],"title":"Response Get Note By Id Notes Note Id Get"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Get Note By Id","tags":["Notes"]},"patch":{"description":"Update a specific note by id","operationId":"update_note_by_id","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Update Note By Id","tags":["Notes"]}},"/notes/{note_id}/amendments/{amendment_id}":{"get":{"description":"Get a specific note amendment (legacy or EN2.1 sections-based).","operationId":"get_note_amendment_by_id","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}},{"in":"path","name":"amendment_id","required":true,"schema":{"title":"Amendment Id","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ElationNoteAmendment"},{"$ref":"#/components/schemas/NoteAmendment"}],"title":"Response Get Note Amendment By Id Notes Note Id Amendments Amendment Id Get"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Get Note Amendment By Id","tags":["Notes"]}},"/v1/notes":{"get":{"description":"Returns a paginated list of note metadata.","operationId":"list_notes_v1","parameters":[{"description":"Limit for pagination","in":"query","name":"limit","required":false,"schema":{"default":20,"description":"Limit for pagination","maximum":100,"minimum":1,"title":"Limit","type":"integer"}},{"description":"Offset for pagination","in":"query","name":"offset","required":false,"schema":{"default":0,"description":"Offset for pagination","title":"Offset","type":"integer"}},{"description":"Filter by practice ID","in":"query","name":"practice_id","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by practice ID","title":"Practice Id"}},{"description":"True to filter to draft notes only. False to include only signed notes. Omit to include both.","in":"query","name":"is_draft","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"True to filter to draft notes only. False to include only signed notes. Omit to include both.","title":"Is Draft"}},{"description":"Filter by patient ID","in":"query","name":"patient","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by patient ID","title":"Patient"}},{"description":"Comma separated list of provider IDs","in":"query","name":"providers","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma separated list of provider IDs","title":"Providers"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_NoteMetadata_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"List Notes V1","tags":["Notes v1"]},"post":{"description":"Create a legacy Note.","operationId":"create_note_v1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Create Note V1","tags":["Notes v1"]}},"/v1/notes/{note_id}":{"delete":{"description":"Delete a specific draft legacy Note.","operationId":"delete_note_by_id_v1","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"204":{"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Delete Note By Id V1","tags":["Notes v1"]},"get":{"description":"Get a specific legacy Note. Returns HTTP 400 if the note uses the EN2.1 schema.","operationId":"get_note_by_id_v1","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Get Note By Id V1","tags":["Notes v1"]},"patch":{"description":"Update a legacy Note. Returns HTTP 400 if the note uses the EN2.1 schema\n(pass ``content_map`` and use the /v2/ endpoint instead).","operationId":"update_note_by_id_v1","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Update Note By Id V1","tags":["Notes v1"]}},"/v2/notes":{"get":{"description":"Returns a paginated list of note metadata.","operationId":"list_notes_v2","parameters":[{"description":"Limit for pagination","in":"query","name":"limit","required":false,"schema":{"default":20,"description":"Limit for pagination","maximum":100,"minimum":1,"title":"Limit","type":"integer"}},{"description":"Offset for pagination","in":"query","name":"offset","required":false,"schema":{"default":0,"description":"Offset for pagination","title":"Offset","type":"integer"}},{"description":"Filter by practice ID","in":"query","name":"practice_id","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by practice ID","title":"Practice Id"}},{"description":"True to filter to draft notes only. False to include only signed notes. Omit to include both.","in":"query","name":"is_draft","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"True to filter to draft notes only. False to include only signed notes. Omit to include both.","title":"Is Draft"}},{"description":"Filter by patient ID","in":"query","name":"patient","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by patient ID","title":"Patient"}},{"description":"Comma separated list of provider IDs","in":"query","name":"providers","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma separated list of provider IDs","title":"Providers"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_NoteMetadata_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"List Notes V2","tags":["Notes v2"]},"post":{"description":"Create an EN2.1 sections-based Note.","operationId":"create_note_v2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNoteCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNote"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Create Note V2","tags":["Notes v2"]}},"/v2/notes/{note_id}":{"delete":{"description":"Delete a specific draft EN2.1 Note.","operationId":"delete_note_by_id_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"204":{"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Delete Note By Id V2","tags":["Notes v2"]},"get":{"description":"Get a specific EN2.1 sections-based Note. Returns HTTP 400 if the note\nuses the legacy schema.","operationId":"get_note_by_id_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNote"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Get Note By Id V2","tags":["Notes v2"]},"patch":{"description":"Update an EN2.1 sections-based Note.","operationId":"update_note_by_id_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNoteUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNote"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Update Note By Id V2","tags":["Notes v2"]}},"/v2/notes/{note_id}/amendments":{"post":{"description":"Create an EN2.1 note amendment. If a draft amendment already exists, returns it\n(HTTP 200). The parent note must be a signed sections-based note.","operationId":"create_note_amendment_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNoteAmendment"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Create Note Amendment V2","tags":["Notes v2"]}},"/v2/notes/{note_id}/amendments/{amendment_id}":{"delete":{"description":"Delete a specific draft EN2.1 note amendment.","operationId":"delete_note_amendment_by_id_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}},{"in":"path","name":"amendment_id","required":true,"schema":{"title":"Amendment Id","type":"integer"}}],"responses":{"204":{"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Delete Note Amendment By Id V2","tags":["Notes v2"]},"get":{"description":"Get a specific EN2.1 note amendment.","operationId":"get_note_amendment_by_id_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}},{"in":"path","name":"amendment_id","required":true,"schema":{"title":"Amendment Id","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNoteAmendment"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Get Note Amendment By Id V2","tags":["Notes v2"]},"patch":{"description":"Update a draft EN2.1 note amendment.","operationId":"update_note_amendment_by_id_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}},{"in":"path","name":"amendment_id","required":true,"schema":{"title":"Amendment Id","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNoteAmendmentUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNoteAmendment"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Update Note Amendment By Id V2","tags":["Notes v2"]}},"/v2/notes/{note_id}/doctags":{"get":{"description":"List all doctags for an EN2.1 sections-based Note. Returns HTTP 400 if\nthe note uses the legacy schema.","operationId":"list_note_doctags_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Doctag"},"title":"Response List Note Doctags V2 V2 Notes Note Id Doctags Get","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"List Note Doctags V2","tags":["Notes v2"]},"patch":{"description":"Add a doctag to an EN2.1 sections-based Note. The doctag will be upserted\ninto the database and linked to the note. Returns HTTP 400 if the note\nuses the legacy schema.","operationId":"add_doctag_to_note_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDoctagRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Doctag"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Add Doctag To Note V2","tags":["Notes v2"]}},"/v2/notes/{note_id}/doctags/{doctag_id}":{"delete":{"description":"Remove a doctag from an EN2.1 sections-based Note. Returns HTTP 400 if\nthe note uses the legacy schema.","operationId":"delete_doctag_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}},{"in":"path","name":"doctag_id","required":true,"schema":{"title":"Doctag Id","type":"integer"}}],"responses":{"204":{"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Delete Doctag V2","tags":["Notes v2"]}},"/v2/notes/{note_id}/edit":{"get":{"description":"Fetch an EN2.1 note for editing. Creates a snapshot and returns ``snapshot_id``\nfor collaborative PATCH updates.","operationId":"get_note_for_edit_v2","parameters":[{"in":"path","name":"note_id","required":true,"schema":{"title":"Note Id","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElationNote"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"RequireAuthentication":[]},{"RequirePracticeAuthorization":[]}],"summary":"Get Note For Edit V2","tags":["Notes v2"]}}},"components":{"schemas":{"AiGenerationInfo":{"properties":{"is_finalized":{"default":true,"title":"Is Finalized","type":"boolean"},"transcript_source_text":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Transcript Source Text"}},"title":"AiGenerationInfo","type":"object"},"AllergiesNode-Input":{"additionalProperties":true,"properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnyNodeContent"},"type":"array"},{"type":"null"}],"default":[],"items":{"anyOf":[{"$ref":"#/components/schemas/BlockNode-Input"},{"$ref":"#/components/schemas/NoteAssistNode-Input"}]},"title":"Content","type":"array"},"type":{"const":"allergies","default":"allergies","title":"Type","type":"string"}},"title":"AllergiesNode","type":"object"},"AllergiesNode-Output":{"additionalProperties":true,"properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnyNodeContent"},"type":"array"},{"type":"null"}],"default":[],"items":{"anyOf":[{"$ref":"#/components/schemas/BlockNode-Output"},{"$ref":"#/components/schemas/NoteAssistNode-Output"}]},"title":"Content","type":"array"},"type":{"const":"allergies","default":"allergies","title":"Type","type":"string"}},"title":"AllergiesNode","type":"object"},"AnyNodeContent":{"additionalProperties":true,"description":"Placeholder for node content, eliminating cycles in OpenAPI schema generation.\nThis should be replaced with any node content type when calling the API","properties":{},"title":"AnyNodeContent","type":"object"},"AssessmentPlan2Node-Input":{"additionalProperties":true,"description":"An assessment & plan node with a more clinically opinionated structure\nthan `AssessmentPlanNode`.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"$ref":"#/components/schemas/AssessmentPlanItemNode-Input"},"title":"Content","type":"array"},"type":{"const":"assessmentPlan2","default":"assessmentPlan2","title":"Type","type":"string"}},"title":"AssessmentPlan2Node","type":"object"},"AssessmentPlan2Node-Output":{"additionalProperties":true,"description":"An assessment & plan node with a more clinically opinionated structure\nthan `AssessmentPlanNode`.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"$ref":"#/components/schemas/AssessmentPlanItemNode-Output"},"title":"Content","type":"array"},"type":{"const":"assessmentPlan2","default":"assessmentPlan2","title":"Type","type":"string"}},"title":"AssessmentPlan2Node","type":"object"},"AssessmentPlanItemNode-Input":{"additionalProperties":true,"description":"A top-level list item node within an `AssessmentPlan2Node`.\n\nFor nested lists/list items, see `AssessmentPlanListNode` and\n`AssessmentPlanListItemNode`.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/AssessmentPlanItemTitleNode-Input"},{"$ref":"#/components/schemas/AssessmentPlanListNode-Input"}]},"title":"Content","type":"array"},"type":{"const":"assessmentPlanItem","default":"assessmentPlanItem","title":"Type","type":"string"}},"title":"AssessmentPlanItemNode","type":"object"},"AssessmentPlanItemNode-Output":{"additionalProperties":true,"description":"A top-level list item node within an `AssessmentPlan2Node`.\n\nFor nested lists/list items, see `AssessmentPlanListNode` and\n`AssessmentPlanListItemNode`.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/AssessmentPlanItemTitleNode-Output"},{"$ref":"#/components/schemas/AssessmentPlanListNode-Output"}]},"title":"Content","type":"array"},"type":{"const":"assessmentPlanItem","default":"assessmentPlanItem","title":"Type","type":"string"}},"title":"AssessmentPlanItemNode","type":"object"},"AssessmentPlanItemTitleNode-Input":{"additionalProperties":true,"description":"Title node for an `AssessmentPlanItemNode`. This represents a top-\nlevel list item within an `AssessmentPlan2Node`, and is typically\nused to hold a `ProblemNode` and any related text.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/ParagraphNode-Input"},{"$ref":"#/components/schemas/BlockMacroNode-Input"},{"$ref":"#/components/schemas/CardiacOrderNode-Input"},{"$ref":"#/components/schemas/DiscontinuePrescriptionNode-Input"},{"$ref":"#/components/schemas/ImagingOrderNode-Input"},{"$ref":"#/components/schemas/LabOrderNode-Input"},{"$ref":"#/components/schemas/PrescriptionNode-Input"},{"$ref":"#/components/schemas/PulmonaryOrderNode-Input"},{"$ref":"#/components/schemas/ReferralNode-Input"},{"$ref":"#/components/schemas/SleepOrderNode-Input"},{"$ref":"#/components/schemas/CustomBlockNode-Input"}]},"title":"Content","type":"array"},"type":{"const":"assessmentPlanItemTitle","default":"assessmentPlanItemTitle","title":"Type","type":"string"}},"title":"AssessmentPlanItemTitleNode","type":"object"},"AssessmentPlanItemTitleNode-Output":{"additionalProperties":true,"description":"Title node for an `AssessmentPlanItemNode`. This represents a top-\nlevel list item within an `AssessmentPlan2Node`, and is typically\nused to hold a `ProblemNode` and any related text.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/ParagraphNode-Output"},{"$ref":"#/components/schemas/BlockMacroNode-Output"},{"$ref":"#/components/schemas/CardiacOrderNode-Output"},{"$ref":"#/components/schemas/DiscontinuePrescriptionNode-Output"},{"$ref":"#/components/schemas/ImagingOrderNode-Output"},{"$ref":"#/components/schemas/LabOrderNode-Output"},{"$ref":"#/components/schemas/PrescriptionNode-Output"},{"$ref":"#/components/schemas/PulmonaryOrderNode-Output"},{"$ref":"#/components/schemas/ReferralNode-Output"},{"$ref":"#/components/schemas/SleepOrderNode-Output"},{"$ref":"#/components/schemas/CustomBlockNode-Output"}]},"title":"Content","type":"array"},"type":{"const":"assessmentPlanItemTitle","default":"assessmentPlanItemTitle","title":"Type","type":"string"}},"title":"AssessmentPlanItemTitleNode","type":"object"},"AssessmentPlanListItemNode-Input":{"additionalProperties":true,"description":"A list item node within an `AssessmentPlanList`.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"$ref":"#/components/schemas/ParagraphNode-Input"},"title":"Content","type":"array"},"type":{"const":"assessmentPlanListItem","default":"assessmentPlanListItem","title":"Type","type":"string"}},"title":"AssessmentPlanListItemNode","type":"object"},"AssessmentPlanListItemNode-Output":{"additionalProperties":true,"description":"A list item node within an `AssessmentPlanList`.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"$ref":"#/components/schemas/ParagraphNode-Output"},"title":"Content","type":"array"},"type":{"const":"assessmentPlanListItem","default":"assessmentPlanListItem","title":"Type","type":"string"}},"title":"AssessmentPlanListItemNode","type":"object"},"AssessmentPlanListNode-Input":{"additionalProperties":true,"description":"A list node specific to `AssessmentPlan2Node`. This is effectively a\nnested list within an `AssessmentPlanItemNode`.\n\nFor the top-level list items within `AssessmentPlan2Node`, see\n`AssessmentPlanItemNode`. Top-level items are handled differently\nbecause in a completed note, they should each contain a problem/IMO\ncode (stored in the `AssessmentPlanItemTitleNode`).","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"$ref":"#/components/schemas/AssessmentPlanListItemNode-Input"},"title":"Content","type":"array"},"type":{"const":"assessmentPlanList","default":"assessmentPlanList","title":"Type","type":"string"}},"title":"AssessmentPlanListNode","type":"object"},"AssessmentPlanListNode-Output":{"additionalProperties":true,"description":"A list node specific to `AssessmentPlan2Node`. This is effectively a\nnested list within an `AssessmentPlanItemNode`.\n\nFor the top-level list items within `AssessmentPlan2Node`, see\n`AssessmentPlanItemNode`. Top-level items are handled differently\nbecause in a completed note, they should each contain a problem/IMO\ncode (stored in the `AssessmentPlanItemTitleNode`).","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"items":{"$ref":"#/components/schemas/AssessmentPlanListItemNode-Output"},"title":"Content","type":"array"},"type":{"const":"assessmentPlanList","default":"assessmentPlanList","title":"Type","type":"string"}},"title":"AssessmentPlanListNode","type":"object"},"AssessmentPlanNode-Input":{"additionalProperties":true,"description":"Block node for patient's assessment and plan.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/AnyNodeContent"},"type":"array"},{"type":"null"}],"default":[],"items":{"anyOf":[{"$ref":"#/components/schemas/BlockNode-Input"},{"$ref":"#/components/schemas/NoteAssistNode-Input"}]},"title":"Content","type":"array"},"type":{"const":"assessmentPlan","default":"assessmentPlan","title":"Type","type":"string"}},"title":"AssessmentPlanNode","type":"object"},"AssessmentPlanNode-Output":{"additionalProperties":true,"description":"Block node for patient's assessment and plan.","properties":{"attrs":{"anyOf":[{"$ref":"#/components/schemas/el8_note_models__note__content__base_node__Node__NodeAttrs"},{"type":"null"}]},"content":{"anyOf":[{"item
# --- truncated at 32 KB (237 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/openapi/elation-visit-notes-api.json