Create Encounter

Encounter or appointment is the instance of the care flow that is identified by its Service Type.

Create an Encounter

curl --location 'https://encounters.play.medeintegra.dev/encounters/create' \
--header 'Authorization: Bearer <<JWT_TOKEN>>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "patientInfo": {
        "appUserId": "<<UNIQUE_ID_FOR_USER>>",
        "appUserDisplayId": "<<UNIQUE_DISPLAY_ID_FOR_USER>>",
        "firstName": "Rahul Vinod",
        "lastName": "Upputuri",
        "fullName": "Rahul Vinod Upputuri",
        "dobInEpoch": 696105000,
        "gender": "Male",
        "email": "tacticurv@gmail.com",
        "mobileNumber": "8884888978",
        "dp": "https://blob.play.medeintegra.dev/blob/mede_blob_d8ab8897-c305-4928-aa3a-6287c49c35fb.jpeg"
    },
    "facilityInfo": {
        "facilityId": "hng-dev-facility",
        "facilityName": "HNG Dev"
    },
    "serviceType": "URLIFE_OHC"
}'

API Fields Description

Patient Info

Field	Description	Type	Required
appUserId	Unique ID for the user as identified in your system	String	Yes
appUserDisplayId	Unique Display ID for the user as identified in your system. This is used for display in UI and print in reports as unique ID for the patient	String	Yes
firstName	First Name of the patient	String	Yes
lastName	Last Name of the patient	String	Yes
fullName	Full Name of the patient	String	Yes
dobInEpoch	Date of birth in Epoch Format in seconds	Number	Yes
gender	'Male' or 'Female' or 'Others'	String	Yes
email	EmailId of the patient	String	Yes
mobileNumber	Mobile Number of the patient in 10 digits Indian Phone Number	String	Yes
dp	URL with blob. Recommend to keep small size	String	No

Facility Info

Field	Description	Type	Required
facilityId	Unique ID for the facility. Should be same as available in Admin.	String	Yes
facilityName	Name of the facility. Should be same as available in Admin.	String	Yes

Service Type

Field	Description	Type	Required
serviceType	Service Type of the encounter. Unique Identifier for the Care Flow.	String	Yes