Update Guest EMR Data

This API adds or updates multiple EMR data sections for a guest in a single API call. Supports allergies, medications, medical histories, social history, and vitals — each section is optional and processed independently in parallel, with per-section error reporting.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

EMRDataModel

Json PropertyData TypeDescription
allergiesListList of guest allergy records to add or update.
medicationsListList of guest medication records to add or update.
medical_historiesListList of guest medical history records to add or update.
social_historyListList of social history fields to add or update.
vitalsListList of vital sign fields to add or update.

GuestAllergy

Json PropertyData TypeDescription
allergy_idGuid?Unique identifier of the allergy record. Required when updating an existing allergy.
categoryAllergyCategoryCategory of the allergy.
allergy_namestringName of the allergy.
severityAllergySeveritySeverity level of the allergy.
sourceAllergySourceSource from which the allergy information was obtained.
is_activeboolIndicates whether the allergy is currently active.
statusAllergyStatusStatus of the allergy record.
created_byCreatedByObjectInformation about the user who created the allergy record.
modified_byCreatedByObjectInformation about the user who last modified the allergy record.

GuestMedication

Json PropertyData TypeDescription
medication_idGuid?Unique identifier of the medication record. Required when updating an existing medication.
medication_namestringName of the medication.
start_dateDateTime?Date when the medication was started.
end_dateDateTime?Date when the medication was stopped.
statusMedicationStatusCurrent status of the medication.
created_byCreatedByObjectInformation about the user who created the medication record.
modified_byCreatedByObjectInformation about the user who last modified the medication record.
notesstringAdditional notes about the medication.
medication_sourceProviderTypeSource/provider of the medication information.
critical_typeCriticalType?Criticality classification of the medication.
guest_medication_idlong?Internal guest medication identifier.
is_customboolIndicates whether the medication is custom-defined.
data_sourceMedicationDataSource?Source system from which the medication data originated.
related_typeFormRelatedType?Type of related entity associated with the medication entry.

MedicalHistory

Json PropertyData TypeDescription
guest_condition_idGuid?Unique identifier of the guest medical history record.
health_condition_idGuid?Unique identifier of the health condition.
condition_namestringName of the medical condition.
categoryMedicalConditionCategory?Category of the medical condition.
diagnosis_dateDateTime?Date when the condition was diagnosed.
statusMedicalConditionStatusCurrent status of the medical condition.
resolution_dateDateTime?Date when the condition was resolved.
notesstringAdditional notes about the condition.
is_family_historyboolIndicates whether the condition is part of the guest's family history.
relationship_idGuid?Identifier of the family relationship associated with the condition.
relationship_namestringName of the family relationship associated with the condition.
is_genetic_riskbool?Indicates whether the condition represents a genetic risk.
created_byCreatedByObjectInformation about the user who created the medical history record.
critical_typeCriticalType?Criticality classification of the condition.
modified_byCreatedByObjectInformation about the user who last modified the medical history record.
guest_medical_history_idlong?Internal guest medical history identifier.

EMREntityFieldModel

Json PropertyData TypeDescription
created_byCreatedByObjectInformation about the user who created the field entry.
modified_byCreatedByObjectInformation about the user who last modified the field entry.

EMREntityField

Json PropertyData TypeDescription
idintIdentifier of the EMR field.
namestringInternal name of the field.
display_namestringDisplay name shown to users.
valuestringValue assigned to the field.
value_idstringIdentifier corresponding to the selected field value.
default_valuestringDefault value of the field.
optionsstringAvailable options for the field.
is_enabledboolIndicates whether the field is enabled.
is_requiredboolIndicates whether the field is mandatory.
data_typestringData type of the field value.
critical_typeCriticalType?Criticality classification of the field value.
descriptionstringDescription of the field.
unitstringUnit associated with the field value.
indexintDisplay or processing order of the field.
session_datetimeDateTime?Date and time associated with the field entry.
validationstringValidation rules applied to the field.
entity_idGuid?Identifier of the parent entity.
is_custombool?Indicates whether the field is custom-defined.
user_entity_field_idlong?Internal identifier of the user entity field record.
blood_pressurestringBlood pressure value, when applicable.

CreatedByObject

Json PropertyData TypeDescription
idGuidUnique identifier of the employee or user.
namestringName of the employee or user.
dateDateTimeDate and time when the action occurred.

GuestEMRBulkUpdateRequestModel

Json PropertyData TypeDescription
emr_dataEMRDataModelCollection of EMR sections to add or update for the guest.

GuestEMRBulkUpdateResponseModel

Json PropertyData TypeDescription
emr_dataEMRDataModelSuccessfully processed EMR sections returned after the update.
section_errorsListErrors encountered while processing individual EMR sections.
errorAPICommonErrorModelTop-level error returned when the entire request fails

EMRBulkSectionError

Json PropertyData TypeDescription
sectionstringName of the EMR section that failed processing.
errorAPICommonErrorModelError details for the failed section.

APICommonErrorModel

Json PropertyData TypeDescription
codestringApplication-specific error code.
messagestringHuman-readable error message.

FormRelatedType (Enum)

ValueDescription
0None
1Appointment
2GuestForm
3ePrescribe
Path Params
string
required

Unique identifier of the guest whose EMR data is being upserted

Query Params
string
string
date
string

Identifier of the form that triggered this EMR update

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain