Elation Patient Profile API
Read and write patient demographic and clinical profile data - patients, allergies, problems, medications, vitals, and related clinical records - via the Elation API v2.0.
Elation Patient Profile API is one of 16 APIs that Elation Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Patients, Clinical Data, and Healthcare. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 60 operations across 27 paths, organized into 12 resource areas, and defines 455 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against 2 base URLs: https://sandbox.elationemr.com, https://api.app.elationemr.com.
60 operations
27 paths
455 schemas
12 DELETE25 GET5 PATCH13 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elation Patient Profile API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 4 scopes.
Paths & Operations 60
Across 27 paths, the API surfaces 60 operations — 12 DELETE, 25 GET, 5 PATCH, 13 POST, 5 PUT. They span 12 resource areas, including Allergies, Allergy Documentation (NKDA), Drug Intolerances, Family Histories, Histories, Immunizations, Provider Team, Patients, and 4 more. Each is listed below with its method, path, parameters, and response codes.
Allergies 6
GET
/api/2.0/allergies/
List Allergies
POST
/api/2.0/allergies/
Create Allergy
DELETE
/api/2.0/allergies/{id}/
Delete Allergy
GET
/api/2.0/allergies/{id}/
Retrieve Allergy
PATCH
/api/2.0/allergies/{id}/
Partially Update Allergy
PUT
/api/2.0/allergies/{id}/
Update Allergy
Allergy Documentation (NKDA) 4
GET
/api/2.0/allergy_documentation/
List Allergy Documentations
POST
/api/2.0/allergy_documentation/
Create Allergy Documentation
DELETE
/api/2.0/allergy_documentation/{id}/
Delete Allergy Documentation
GET
/api/2.0/allergy_documentation/{id}/
Retrieve Allergy Documentation
Drug Intolerances 6
GET
/api/2.0/drug_intolerances/
List Drug Intolerances
POST
/api/2.0/drug_intolerances/
Create Drug Intolerance
DELETE
/api/2.0/drug_intolerances/{id}/
Delete Drug Intolerance
GET
/api/2.0/drug_intolerances/{id}/
Retrieve Drug Intolerance
PATCH
/api/2.0/drug_intolerances/{id}/
Partially Update Drug Intolerance
PUT
/api/2.0/drug_intolerances/{id}/
Update Drug Intolerance
Family Histories 4
GET
/api/2.0/family_histories/
List Family Histories
POST
/api/2.0/family_histories/
Create Family History
DELETE
/api/2.0/family_histories/{id}/
Delete Family History
GET
/api/2.0/family_histories/{id}/
Retrieve Family History
Histories 4
GET
/api/2.0/histories/
List Histories
POST
/api/2.0/histories/
Create History
DELETE
/api/2.0/histories/{id}/
Delete History
GET
/api/2.0/histories/{id}/
Retrieve History
Immunizations 4
GET
/api/2.0/immunizations/
List Immunizations
POST
/api/2.0/immunizations/
Create Immunization
DELETE
/api/2.0/immunizations/{id}/
Delete Immunization
GET
/api/2.0/immunizations/{id}/
Retrieve Immunization
Provider Team 9
POST
/api/2.0/patient-provider-team-members/
Create Patient Provider Team Member
DELETE
/api/2.0/patient-provider-team-members/{id}/
Delete Patient Provider Team Member
PATCH
/api/2.0/patient-provider-team-members/{id}/
Partially Update Patient Provider Team Member
PUT
/api/2.0/patient-provider-team-members/{id}/
Update Patient Provider Team Member
GET
/api/2.0/patient-provider-teams/
List Patient Provider Teams
GET
/api/2.0/patient-provider-teams/{id}/
Retrieve Patient Provider Team
GET
/api/2.0/patient-provider-teams/{id}/team_members/
Retrieve Patient Provider Teams Team Member
GET
/api/2.0/patients/{id}/patient_provider_team/
Retrieve Patients Patient Provider Team
POST
/api/2.0/patients/{id}/patient_provider_team/
Create Patients Patient Provider Team
Patients 6
GET
/api/2.0/patients/
List Patients
POST
/api/2.0/patients/
Create Patient
DELETE
/api/2.0/patients/{id}/
Delete Patient
GET
/api/2.0/patients/{id}/
Retrieve Patient
PATCH
/api/2.0/patients/{id}/
Partially Update Patient
PUT
/api/2.0/patients/{id}/
Update Patient
Patient Profile Photo 4
GET
/api/2.0/patients/{id}/get_photo/
Retrieve Patients Get Photo
DELETE
/api/2.0/patients/{id}/profile_image/
Delete Patients Profile Image
GET
/api/2.0/patients/{id}/profile_image/
Retrieve Patients Profile Image
POST
/api/2.0/patients/{id}/profile_image/
Create Patients Profile Image
Insurance Card 3
DELETE
/api/2.0/patients/{id}/insurance_cards/
Delete Patients Insurance Card
GET
/api/2.0/patients/{id}/insurance_cards/
List Patients Insurance Cards
POST
/api/2.0/patients/{id}/insurance_cards/
Create Patients Insurance Card
Problems 6
GET
/api/2.0/problems/
List Problems
POST
/api/2.0/problems/
Create Problem
DELETE
/api/2.0/problems/{id}/
Delete Problem
GET
/api/2.0/problems/{id}/
Retrieve Problem
PATCH
/api/2.0/problems/{id}/
Partially Update Problem
PUT
/api/2.0/problems/{id}/
Update Problem
Vaccine 4
GET
/api/2.0/vaccine/
List Vaccines
POST
/api/2.0/vaccine/
Create Vaccine
DELETE
/api/2.0/vaccine/{id}/
Delete Vaccine
GET
/api/2.0/vaccine/{id}/
Retrieve Vaccine
Schemas 455
The contract defines 455 schemas that model the data the API accepts and returns. The most detailed are Patient (53 properties), PatchedPatient (53 properties), Insurance (33 properties), PatchedLetter (32 properties). Each schema is shown below with its type and property counts.
AbnormalFlagEnum
string
AccountTypeEnum
string
regular - Regular staff oncall - On call (not paid) ftnonprescribing - Full-Time Non-Prescribing ptprescribing - Limited Use
Actor
object
3 properties
1 required
AddSignaturesToNote
object
4 properties
Address
object
5 properties
AllergyStatus
string
AmendmentRequest
object
5 properties
3 required
AmendmentRequestStatusEnum
string
AmendmentSourceEnum
string
AncillaryCompany
object
2 properties
1 required
Appointment
object
25 properties
4 required
AppointmentBillingDetails
object
4 properties
AppointmentStatus
object
4 properties
1 required
AppointmentStatusStatusEnum
string
AppointmentType
object
18 properties
3 required
AscvdEligibility
object
Response schema for the ASCVD (G0537) eligibility endpoint (docs only).
3 properties
3 required
AscvdEligibilityCriterion
object
4 properties
4 required
AttachmentTypeEnum
string
Entity - Entity RefPanel - RefPanel PatientDemog - PatientDemog ImmHistory - ImmHistory MedsList - MedsList CompMedsList - CompMedsList WhoHeightChart - WhoHei…
AuthorizationForEnum
string
BiDiLabConnection
object
5 properties
Bill
object
28 properties
3 required
BillSingleInstance
object
17 properties
6 required
BillTypeEnum
string
thirdparty - Third Party (e.g. Insurance) patient - Patient client - Client workerscomp - Worker's Comp specialbilling - Special Billing
BillUpdate
object
18 properties
BillUpdatePlaceOfServiceEnum
string
BillingStatusEnum
string
BlankEnum
BodySite
object
3 properties
2 required
BodySiteCodeModifier
object
3 properties
2 required
BulletWithMeta
object
11 properties
2 required
CCDA
object
2 properties
1 required
CPT
object
11 properties
4 required
CPTCode
object
6 properties
3 required
CardiacCenter
object
14 properties
6 required
CardiacOrder
object
21 properties
8 required
CardiacOrderTest
object
6 properties
2 required
CategoryEnum
string
CodeTypeEnum
string
CodedDocumentTag
object
11 properties
1 required
Comment
object
6 properties
1 required
ConceptNameEnum
string
Consent
object
This is the serializer for PatientConsent. It's all read-only
4 properties
Contact
object
30 properties
6 required
ContactsSearchResult
object
Serializer used to work with contacts found via elasticsearch
16 properties
1 required
Content
object
The Content serializer. It serialize file data
3 properties
2 required
ContentSerializerNoBase64Content
object
The Content serializer. It serialize file data without base64content
2 properties
2 required
CreateInsuranceCard
object
3 properties
3 required
CreateInsuranceEligibility
object
3 properties
CreatePaymentLink
object
6 properties
3 required
DX
object
2 properties
1 required
DataFormatEnum
string
DataImportRequest
object
Used with resources that are accessed through a public API application.
5 properties
2 required
DataImportRequestDetail
object
Main difference vs list is we don't want users changing the below fields after creation and we want to show the import status
6 properties
DelegatePermission
object
6 properties
4 required
DeliveryMethodEnum
string
DiagnosisCode
object
2 properties
2 required
DiscontinueMedOrder
object
19 properties
1 required
Document
object
11 properties
5 required
DocumentResolutionState
object
7 properties
1 required
DoseUnitEnum
string
dL - Deciliter g - Gram kg - Kilogram kL - Kiloliter L - Liter mCi - Millicurie mg - Milligram mL - Milliliter ug - Microgram uL - Microliter tab - Tablet
EligibilityAddress
object
5 properties
EligibilityBenefits
object
5 properties
EligibilityDetails
object
9 properties
EligibilityPlanDetails
object
12 properties
EligibilityProvider
object
4 properties
EligibilityStatusEnum
string
active - active inactive - inactive error - error
EligibilitySubscriber
object
7 properties
EligibilityUsage
object
5 properties
Email
object
3 properties
EmergencyContact
object
10 properties
Employer
object
3 properties
1 required
ErrorCodeEnum
string
ErrorDescriptionCodeEnum
string
EthnicityEnum
string
FacilityIdentifier
object
14 properties
5 required
FastingMethodEnum
string
fasting12hour - Fasting - 12 hours fasting8hours - Fasting - 8 hours fasting2hours - Fasting - 2 hours fastingnone - Non-Fasting fastingrandom - Fasting or non…
File
object
10 properties
3 required
FillStatusEnum
string
AH - Dispensed AJ - PartiallyDispensed AK - NotDispensed AL - Transferred
Fulfillment
object
6 properties
3 required
FulfillmentTypeEnum
string
surescripts - surescripts surescriptscancel - surescriptscancel surescriptschange - surescriptschange surescriptsnonfillable - Surescripts-Nonfillable paper -…
FundingSourceEnum
string
GenderIdentityEnum
string
GroupEnum
string
main - main other - other
Guarantor
object
10 properties
Handout
object
Contains only webhooks All other fields inherited
10 properties
4 required
HandoutType
string
HandoutsSerializerNoBase64Content
object
Handout serializer that returns content without base64content
10 properties
4 required
ICD10Code
object
2 properties
1 required
Image
object
21 properties
2 required
ImageContent
object
2 properties
2 required
ImagingCenter
object
14 properties
6 required
ImagingOrder
object
21 properties
8 required
ImagingOrderTest
object
6 properties
2 required
ImmunizationVaccine
object
4 properties
ImoCodeRelation
object
3 properties
InactiveReasonEnum
string
leftgoodterms - Patient Left on Good Terms leftbadterms - Patient Left on Bad Terms practiceended - Practice Ended Relationship other - Other unknown - Unknown
IncomingFileGroup
object
22 properties
2 required
InfoSourceEnum
string
Injection
object
27 properties
3 required
Insurance
object
33 properties
1 required
InsuranceCard
object
2 properties
2 required
InsuranceCardImage
object
3 properties
3 required
InsuranceCompany
object
19 properties
2 required
InsuranceCompanySingleInstance
object
21 properties
2 required
InsuranceEligibility
object
6 properties
InsuranceEligibilityFullReport
object
9 properties
InsurancePlan
object
6 properties
3 required
InsurancePlanSingleInstance
object
7 properties
3 required
InsuranceTypeEnum
string
InsurerRelationshipType
string
InternalPracticeNoteSerializerProxy
object
3 properties
1 required
LabOrder
object
27 properties
4 required
LabOrderAOEAnswer
object
6 properties
1 required
LabOrderAOEQuestion
object
10 properties
3 required
LabOrderAOEQuestionChoice
object
5 properties
2 required
LabOrderContent
object
10 properties
LabOrderSet
object
8 properties
3 required
LabOrderSpecimen
object
7 properties
4 required
LabOrderSpecimenModifier
object
4 properties
3 required
LabOrderSubmission
object
6 properties
1 required
LabOrderTest
object
12 properties
1 required
LabOrderTestCompendium
object
The serializer for LabOrderTestCompendium
7 properties
2 required
LabOrderTestToLabOrderAOEQuestion
object
4 properties
2 required
LabOrderTestWithDiagnoses
object
13 properties
2 required
LabResult
object
12 properties
10 required
LabResultStatus
string
LabResultsGrid
object
6 properties
6 required
LabTest
object
3 properties
3 required
LabTestCategory
object
2 properties
2 required
LabVendor
object
The serializer for LabVendor
13 properties
2 required
LabVendorIdName
object
LabVendor Serializer useful for simple, read-only reference.
3 properties
LabVendorIntegration
object
Serializer for non-internal usage to align better with APIv2 conventions
8 properties
4 required
LabVendorIntegrationStatus
string
LabVendorPatientSite
object
The serializer for LabVendorPatientSite
13 properties
1 required
Language
object
1 property
1 required
LegalGenderMarkerDisplayEnum
string
LegalGenderMarkerEnum
string
Letter
object
32 properties
3 required
LetterAttachment
object
8 properties
1 required
LetterCategory
object
4 properties
3 required
ListCPT
object
10 properties
10 required
MedOrder
object
31 properties
13 required
MedOrderTemplate
object
Contains only webhooks All other fields inherited
10 properties
2 required
MedicalSpecialty
object
6 properties
2 required
MedicalSpecialtyCategory
object
4 properties
1 required
Medication
object
17 properties
MedicationDrugType
string
user - user medispan - medispan ss - surescripts disp - dispensary
MedicationHistoryDownloadFill
object
27 properties
25 required
MedicationType
string
otc - otc prescription - prescription discontinued - discontinued
MedicationTypeEnum
string
otc - otc prescription - prescription
MessageThread
object
13 properties
4 required
MethodEnum
string
Intravenous - Intravenous Intramuscular - Intramuscular Subcutaneous - Subcutaneous Intradermal - Intradermal Other - Other
ModeEnum
string
MultiStateIdentifiers
object
3 properties
1 required
NdcMeasureEnum
string
GR - GR F2 - F2 ME - ME ML - ML UN - UN
NonVisitNote
object
13 properties
4 required
NonVisitNoteBullet
object
5 properties
1 required
NonVisitNoteDocument
object
3 properties
1 required
NonVisitNotePatientItem
object
2 properties
1 required
NullEnum
null
OrderStatusEnum
string
OrderTypeEnum
string
New - New Refill - Refill DoseChange - Change
PackagedMedication
object
21 properties
PackagedMedicationLabeler
object
3 properties
3 required
PaginatedAncillaryCompanyList
object
4 properties
1 required
PaginatedAppointmentList
object
4 properties
1 required
PaginatedAppointmentTypeList
object
4 properties
1 required
PaginatedBillList
object
4 properties
1 required
PaginatedCPTCodeList
object
4 properties
1 required
PaginatedCardiacCenterList
object
4 properties
1 required
PaginatedCardiacOrderList
object
4 properties
1 required
PaginatedCardiacOrderTestList
object
4 properties
1 required
PaginatedCodedDocumentTagList
object
4 properties
1 required
PaginatedCommentList
object
4 properties
1 required
PaginatedContactList
object
4 properties
1 required
PaginatedContactsSearchResultList
object
4 properties
1 required
PaginatedDataImportRequestList
object
4 properties
1 required
PaginatedDelegatePermissionList
object
4 properties
1 required
PaginatedDiscontinueMedOrderList
object
4 properties
1 required
PaginatedFacilityIdentifierList
object
4 properties
1 required
PaginatedHandoutsSerializerNoBase64ContentList
object
4 properties
1 required
PaginatedImagingCenterList
object
4 properties
1 required
PaginatedImagingOrderList
object
4 properties
1 required
PaginatedImagingOrderTestList
object
4 properties
1 required
PaginatedIncomingFileGroupList
object
4 properties
1 required
PaginatedInjectionList
object
4 properties
1 required
PaginatedInsuranceCompanyList
object
4 properties
1 required
PaginatedInsurancePlanList
object
4 properties
1 required
PaginatedLabOrderList
object
4 properties
1 required
PaginatedLabOrderSetList
object
4 properties
1 required
PaginatedLabOrderTestCompendiumList
object
4 properties
1 required
PaginatedLabOrderTestList
object
4 properties
1 required
PaginatedLabVendorIntegrationList
object
4 properties
1 required
PaginatedLabVendorList
object
4 properties
1 required
PaginatedLabVendorPatientSiteList
object
4 properties
1 required
PaginatedLanguageList
object
4 properties
1 required
PaginatedLetterCategoryList
object
4 properties
1 required
PaginatedLetterList
object
4 properties
1 required
PaginatedMedOrderList
object
4 properties
1 required
PaginatedMedOrderTemplateList
object
4 properties
1 required
PaginatedMedicalSpecialtyList
object
4 properties
1 required
PaginatedMedicationHistoryDownloadFillList
object
4 properties
1 required
PaginatedMedicationList
object
4 properties
1 required
PaginatedMessageThreadList
object
4 properties
1 required
PaginatedNonVisitNoteList
object
4 properties
1 required
PaginatedPackagedMedicationLabelerList
object
4 properties
1 required
PaginatedPackagedMedicationList
object
4 properties
1 required
PaginatedPatientAllergyDocumentationList
object
4 properties
1 required
PaginatedPatientAllergyList
object
4 properties
1 required
PaginatedPatientChartImportList
object
4 properties
1 required
PaginatedPatientDrugIntoleranceList
object
4 properties
1 required
PaginatedPatientFamilyHistoryList
object
4 properties
1 required
PaginatedPatientFormList
object
4 properties
1 required
PaginatedPatientFormRequestList
object
4 properties
1 required
PaginatedPatientFormSubmissionList
object
4 properties
1 required
PaginatedPatientHistoryList
object
4 properties
1 required
PaginatedPatientImmunizationList
object
4 properties
1 required
PaginatedPatientImplantableDeviceList
object
4 properties
1 required
PaginatedPatientLetterList
object
4 properties
1 required
PaginatedPatientLiabilityList
object
4 properties
1 required
PaginatedPatientList
object
4 properties
1 required
PaginatedPatientProblemList
object
4 properties
1 required
PaginatedPatientProviderTeamList
object
4 properties
1 required
PaginatedPatientSmokingStatusList
object
4 properties
1 required
PaginatedPharmacyList
object
4 properties
1 required
PaginatedPhysicianList
object
4 properties
1 required
PaginatedPracticeFaxList
object
4 properties
1 required
PaginatedPracticeList
object
4 properties
1 required
PaginatedPracticePrintHeaderList
object
4 properties
1 required
PaginatedPracticeToStaffList
object
4 properties
1 required
PaginatedPrescriptionFillList
object
4 properties
1 required
PaginatedPublishedEventList
object
4 properties
1 required
PaginatedPulmonaryCenterList
object
4 properties
1 required
PaginatedPulmonaryOrderList
object
4 properties
1 required
PaginatedPulmonaryOrderTestList
object
4 properties
1 required
PaginatedRecurringEventGroupList
object
4 properties
1 required
PaginatedReferenceMedicationList
object
4 properties
1 required
PaginatedReferralOrderList
object
4 properties
1 required
PaginatedReportList
object
4 properties
1 required
PaginatedReportTypeList
object
4 properties
1 required
PaginatedRxHistoryDownloadList
object
4 properties
1 required
PaginatedRxRefillRequestList
object
4 properties
1 required
PaginatedServiceLocationList
object
4 properties
1 required
PaginatedSleepCenterList
object
4 properties
1 required
PaginatedSleepOrderList
object
4 properties
1 required
PaginatedSleepOrderTestList
object
4 properties
1 required
PaginatedStaffGroupList
object
4 properties
1 required
PaginatedSubscriptionList
object
4 properties
1 required
PaginatedSupportMessageList
object
4 properties
1 required
PaginatedThreadMemberList
object
4 properties
1 required
PaginatedThreadMessageList
object
4 properties
1 required
PaginatedUserList
object
4 properties
1 required
PaginatedVaccineList
object
4 properties
1 required
PaginatedVisitNoteList
object
4 properties
1 required
PaginatedVisitNoteTemplateList
object
4 properties
1 required
PaginatedVisitNoteTypeList
object
4 properties
1 required
PaginatedVitalsCollectionList
object
4 properties
1 required
PaginatedXmlPatientSummaryList
object
4 properties
1 required
PatchedAddSignaturesToNote
object
4 properties
PatchedAppointment
object
25 properties
PatchedAppointmentType
object
18 properties
PatchedBillUpdate
object
18 properties
PatchedCPTCode
object
6 properties
PatchedCardiacOrder
object
21 properties
PatchedCodedDocumentTag
object
11 properties
PatchedContact
object
30 properties
PatchedDataImportRequestDetail
object
Main difference vs list is we don't want users changing the below fields after creation and we want to show the import status
6 properties
PatchedFacilityIdentifier
object
14 properties
PatchedHandout
object
Contains only webhooks All other fields inherited
10 properties
PatchedImagingOrder
object
21 properties
PatchedInsuranceCompanySingleInstance
object
21 properties
PatchedInsurancePlanSingleInstance
object
7 properties
PatchedInternalPracticeNoteSerializerProxy
object
3 properties
PatchedLabOrder
object
27 properties
PatchedLabOrderSet
object
8 properties
PatchedLabOrderTestCompendium
object
The serializer for LabOrderTestCompendium
7 properties
PatchedLabVendor
object
The serializer for LabVendor
13 properties
PatchedLabVendorIntegration
object
Serializer for non-internal usage to align better with APIv2 conventions
8 properties
PatchedLabVendorPatientSite
object
The serializer for LabVendorPatientSite
13 properties
PatchedLetter
object
32 properties
PatchedMedOrderTemplate
object
Contains only webhooks All other fields inherited
10 properties
PatchedMedicalSpecialty
object
6 properties
PatchedMedication
object
17 properties
PatchedMessageThread
object
13 properties
PatchedNonVisitNote
object
13 properties
PatchedPatient
object
53 properties
PatchedPatientAllergy
object
11 properties
PatchedPatientChartImportDetail
object
This space intentionally left blank
10 properties
PatchedPatientDrugIntolerance
object
9 properties
PatchedPatientFormRequest
object
8 properties
PatchedPatientLetter
object
22 properties
PatchedPatientProblem
object
13 properties
PatchedPatientProviderTeamMemberUpdate
object
10 properties
PatchedPhysician
object
14 properties
PatchedPractice
object
14 properties
PatchedPublishedEvent
object
9 properties
PatchedPulmonaryOrder
object
21 properties
PatchedReferralOrder
object
16 properties
PatchedServiceLocation
object
18 properties
PatchedSleepOrder
object
20 properties
PatchedStaffGroup
object
7 properties
PatchedThreadMember
object
6 properties
PatchedUpdateReport
object
4 properties
PatchedUser
object
13 properties
PatchedVisitNoteTemplate
object
6 properties
PatchedVisitNoteType
object
8 properties
PatchedVitalsCollection
object
24 properties
Patient
object
53 properties
6 required
PatientAllergy
object
11 properties
2 required
PatientAllergyDocumentation
object
4 properties
1 required
PatientAllergySeverityEnum
string
PatientChartImport
object
This space intentionally left blank
9 properties
PatientChartImportDetail
object
This space intentionally left blank
10 properties
PatientChartImportStatus
string
completed - Completed failed - Failed notapplicable - Not Applicable open - Open pending - Pending processing - Processing
PatientDrugIntolerance
object
9 properties
2 required
PatientDrugIntoleranceSeverityEnum
string
- unknown 255604002 - mild 6736007 - moderate 24484000 - severe
PatientDrugIntoleranceStatusEnum
integer
1 - Active 2 - Inactive
PatientFamilyHistory
object
9 properties
2 required
PatientFamilyHistoryRelationshipEnum
string
PatientForm
object
12 properties
7 required
PatientFormRequest
object
8 properties
2 required
PatientFormSubmission
object
10 properties
3 required
PatientHistory
object
7 properties
3 required
PatientHistoryTypeEnum
string
PatientId
object
1 property
1 required
PatientImmunization
object
32 properties
6 required
PatientImplantableDevice
object
22 properties
17 required
PatientItem
object
6 properties
3 required
PatientLetter
object
22 properties
2 required
PatientLiability
object
15 properties
3 required
PatientMatchingResultEnum
string
PatientOutstandingBalance
object
2 properties
1 required
PatientPhoto
object
12 properties
4 required
PatientPreference
object
2 properties
PatientPreviousName
object
4 properties
PatientProblem
object
13 properties
5 required
PatientProblemStatusEnum
string
PatientProviderTeam
object
3 properties
1 required
PatientProviderTeamMember
object
10 properties
2 required
PatientProviderTeamMemberUpdate
object
10 properties
PatientSexEnum
string
PatientSmokingStatus
object
7 properties
2 required
Payment
object
7 properties
2 required
PaymentCharge
object
8 properties
1 required
PaymentProgramEnum
string
PaymentRequest
object
6 properties
2 required
PaymentRequestStatusEnum
string
PermissionTypeEnum
string
Pharmacy
object
14 properties
4 required
Phone
object
4 properties
2 required
PhoneTypeEnum
string
Physician
object
14 properties
6 required
PhysicianQualifications
object
5 properties
3 required
Practice
object
14 properties
3 required
PracticeFax
object
6 properties
3 required
PracticePrintHeader
object
9 properties
1 required
PracticeSpecialInsuranceCodeName
object
2 properties
2 required
PracticeToStaff
object
13 properties
1 required
PracticeToStaffSexEnum
string
PreferredContactEnum
string
PrescriptionFill
object
8 properties
5 required
PriorAuthQualifierEnum
string
94 - Pharmacy or Prescriber File ID 0B - State License Number 1C - Medicare Number 1D - Medicaid Number 1E - Dentist License Number 1G - UPIN 1J - Facility ID…
ProcedureCodes
object
6 properties
2 required
ProcessStateEnum
string
PronounsDisplayEnum
string
PronounsEnum
string
ProviderAvailabilityBlock
object
8 properties
4 required
ProviderAvailabilityBlockSerializerPracticeTimeZone
object
8 properties
4 required
PublicityCodeEnum
string
PublishedEvent
object
9 properties
1 required
PulmonaryCenter
object
14 properties
6 required
PulmonaryOrder
object
21 properties
8 required
PulmonaryOrderTest
object
6 properties
2 required
QtyUnitsEnum
string
BAG - BAG BOTTLE - BOTTLE BOX - BOX CAPSULE - CAPSULE CARTRIDGE - CARTRIDGE CONTAINER - CONTAINER DROP - DROP GRAM - GRAM INHALER - INHALER INTERNATIONAL UNITE…
QuestionTypeEnum
string
enum - enum enummultiselect - enummultiselect freetext - freetext yorn - yorn numeric - numeric yyyymmdd - yyyymmdd 2numeric1decimal - 2numeric1decimal
RaceEnum
string
RankEnum
string
RecurringEventGroup
object
8 properties
3 required
RecurringEventSchedule
object
16 properties
4 required
ReferenceMedication
object
17 properties
ReferralLetter
object
4 properties
ReferralOrder
object
16 properties
7 required
ReferringProvider
object
3 properties
2 required
RepeatsEnum
string
Report
object
23 properties
6 required
ReportImage
object
2 properties
1 required
ReportType
object
5 properties
4 required
ReportTypeEnum
string
RequestingPhysicianActionEnum
string
ReqAct - Requiring Action Addressed - Addressed
RoleEnum
string
RoutedDocumentDelegate
object
Nested serializer for RoutedDocumentDelegate. Returns delegation information for users and groups assigned to review a report. Either user or group will be pop…
5 properties
RxHistoryDownload
object
19 properties
2 required
RxRefillRequest
object
10 properties
6 required
S3RetrievingDocumentFile
object
6 properties
SendToContact
object
7 properties
1 required
ServiceLocation
object
18 properties
4 required
ServiceLocationPlaceOfServiceEnum
string
ServiceLocationStatusEnum
string
SexualOrientationEnum
string
SiteEnum
string
Abdomen - Abdomen R Anterolateral Thigh - R Anterolateral Thigh L Anterolateral Thigh - L Anterolateral Thigh R Posterior Upper Arm - R Posterior Upper Arm L P…
SleepCenter
object
14 properties
6 required
SleepOrder
object
20 properties
8 required
SleepOrderTest
object
6 properties
2 required
SnomedCode
object
2 properties
1 required
SourceEnum
string
StaffGroup
object
7 properties
3 required
StatMethodEnum
string
wetreadingphone - STAT Wet Reading - Please Phone Report wetreadingfax - STAT Wet Reading - Please Fax Report statphone - STAT - Phone statfax - STAT - Fax sta…
StateEnum
string
outstanding - Outstanding fulfilled - Fulfilled cancelled - Cancelled
Status
object
5 properties
StatusStatusEnum
string
active - Active inactive - Inactive prospect - Prospect deceased - Deceased
Subscription
object
7 properties
2 required
SupportMessage
object
9 properties
3 required
TemplateEnum
string
Thread
object
3 properties
1 required
ThreadMember
object
6 properties
1 required
ThreadMemberStatusEnum
string
ThreadMessage
object
8 properties
3 required
TimeSlotStatusEnum
string
TimeSlotTypeEnum
string
TimezoneEnum
string
TransportationDetails
object
Typed API shape for the transportation attribute, backed by the generic AppointmentAttribute store. Fields mirror TransportationAttr; that Pydantic schema is t…
2 properties
UpdateReport
object
4 properties
UploadedPhoto
object
Serializer for UploadedPhoto model. Used for print header images and other cases where we need to serialize an UploadedPhoto directly.
7 properties
User
object
13 properties
6 required
UserTypeEnum
string
Vaccine
object
12 properties
VaccineCreationType
string
ValueTypeEnum
string
VerificationStatusEnum
string
VfcEligibilityEnum
string
VisitNote
object
21 properties
6 required
VisitNoteDocument
object
3 properties
1 required
VisitNoteEdit
object
15 properties
1 required
VisitNoteFormatEnum
string
VisitNoteSignatureList
array
VisitNoteTemplate
object
6 properties
2 required
VisitNoteType
object
8 properties
1 required
VitalBP
object
3 properties
VitalHC
object
4 properties
VitalHCUnitsEnum
string
VitalHR
object
3 properties
VitalHRUnits
string
VitalHeight
object
3 properties
VitalHeightUnitsEnum
string
VitalOxygen
object
3 properties
VitalOxygenUnitsEnum
string
VitalPain
object
2 properties
VitalRR
object
3 properties
VitalTemperature
object
3 properties
VitalTemperatureUnitsEnum
string
VitalWeight
object
3 properties
VitalWeightUnitsEnum
string
VitalsCollection
object
24 properties
2 required
XmlFile
object
Alias for S3RetrievingDocumentFileSerializer with proper OpenAPI schema name.
6 properties
XmlPatientSummary
object
17 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elation Health 12
Other APIs Elation Health publishes across the network.
Elation OAuth API
Elation Visit Notes API
Elation Patient Document API
Elation Orders API
Elation Scheduling API
Elation Billing API
Elation Insurance API
Elation Patient Insurance API (Premium) & Eligibility
Elation Practice API
Elation User Management API
Elation Messaging API
Elation Event Subscription API
#Patients#Clinical Data#Healthcare