Getting Started
API
- POSTAdd Measurement
- POSTAdd Patient Credit
- DELArchive Payment Method
- POSTAssign Patient Tags
- PUTChange Blacklist Status
- POSTChange Patient Archived Status
- POSTContact Us
- POSTCreate Column Mapping
- POSTCreate Dose
- POSTCreate Event Icon
- POSTCreate Patient Credit
- POSTCreate Patient Tag
- POSTCreate Payment Method
- POSTCreate Quick Note
- DELDelete Column Mapping
- DELDelete Document
- DELDelete Dose
- DELDelete Event Icon
- DELDelete Patient Credit
- DELDelete Patient Tag
- DELDelete Quick Note
- GETExternal Id Exists
- GETFind Duplicates
- GETFind Duplicates Of Patient
- GETGet Available Credit
- GETGet Blacklist
- GETGet Column Mapping
- GETGet Event Icon
- GETGet Event Icons
- GETGet Patient
- GETGet Patient Chat Id
- GETGet Patient Credits
- GETGet Patient Documents
- GETGet Patient Ids
- GETGet Patient Reviews
- GETGet Patient Sidebar Snapshot
- GETGet Patient Table
- GETGet Patient Tag
- GETGet Patient Tags
- GETGet Patient Tags For Patient
- GETGet Quick Note
- GETGet Upload Errors
- GETGet Uploads
- GETList Column Mappings
- GETList Patient By Ids
- GETList Quick Notes
- POSTMerge Duplicates
- POSTPatient Create
- GETSearch
- PUTSet Default Column Mapping
- POSTSign Off Dose
- PUTUpdate Dose
- PUTUpdate Event Icon
- PUTUpdate Patient
- PATCHUpdate Patient Credit
- PUTUpdate Patient Dynamic Fields
- PUTUpdate Patient Preferred Provider
- PUTUpdate Patient Tag
- PUTUpdate Quick Note
- PUTUpdate User
- POSTUpload Document
- POSTUpload Patient Profile Picture
- POSTUpload Patients
- POST
Tenant
curl --request GET \
--url https://api.decodahealth.com/user/patient/find-duplicates \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"keep": {
"id": "<string>",
"type": "PROVIDER",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"merge": [
{
"id": "<string>",
"type": "PROVIDER",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
}
],
"voidOtherCharges": false
}
]Find Duplicates
curl --request GET \
--url https://api.decodahealth.com/user/patient/find-duplicates \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"keep": {
"id": "<string>",
"type": "PROVIDER",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"merge": [
{
"id": "<string>",
"type": "PROVIDER",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
}
],
"voidOtherCharges": false
}
]Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
List of patient fields to check for duplicates
Response
Successful Response
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The date and time when the user was created.
The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
The user's external identifier if available.
The user's primary address.
Additional address information.
The city of the user's address.
The state of the user's address.
The postal code of the user's address.
The country of the user's address.
Whether the user's address is valid.
Any additional metadata about the user relevant to your system.
Whether the user is archived.
The primary location of the user.
The gender of the patient.
The date of birth of the patient.
List of patient's self-reported medications.
Whether the patient is on the scheduling blacklist.
Whether surcharges are disabled for this patient.
List of patient tags
Show child attributes
Show child attributes
Unique identifier for the patient tag
Name of the patient tag
Whether the tag is active
Date and time when the tag was created
Emoji associated with the tag
Color code for the tag (hex format)
Date and time when the tag was last updated
Patient's credit balance in cents.
The preferred provider ID for this patient.
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The date and time when the user was created.
The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
The user's external identifier if available.
The user's primary address.
Additional address information.
The city of the user's address.
The state of the user's address.
The postal code of the user's address.
The country of the user's address.
Whether the user's address is valid.
Any additional metadata about the user relevant to your system.
Whether the user is archived.
The primary location of the user.
The gender of the patient.
The date of birth of the patient.
List of patient's self-reported medications.
Whether the patient is on the scheduling blacklist.
Whether surcharges are disabled for this patient.
List of patient tags
Show child attributes
Show child attributes
Unique identifier for the patient tag
Name of the patient tag
Whether the tag is active
Date and time when the tag was created
Emoji associated with the tag
Color code for the tag (hex format)
Date and time when the tag was last updated
Patient's credit balance in cents.
The preferred provider ID for this patient.