HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Powered by HeyDonto
Overview
URL https://heydonto.com
HeyDonto services@heydonto.com
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/
Sandbox
https://api-staging.heydonto.com/
Production
https://api.heydonto.com/

AppointmentType

Operations

Brands

Operations

Dental Practices

Operations

Dental Services

Operations

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Site Assistants

Operations

Periomeasure

Operations

Retrieve Sites all Periomeasures

Request

Path
siteIdnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/periomeasure' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of Sites all Periomeasures retrieved successfully.

Bodyapplication/jsonArray [
siteIdnumberrequired

The ID of the site associated with this periomeasure

practitionerIdnumberrequired

The ID of the FHIR Practitioner associated with this periomeasure

patientIdnumberrequired

The ID of the FHIR Patiend associated with this periomeasure

perioMeasureNumnumberrequired

Periomeasure number

perioExamNumnumberrequired

Periomeasure exam number

sequenceTypenumberrequired

Enum: PerioSequenceType. Possible values are:

  • Mobility: 0
  • Furcation: 1
  • GingMargin: 2 (AKA recession)
  • MGJ: 3 (MucoGingivalJunction - the division between attached and unattached mucosa)
  • Probing: 4
  • SkipTooth: 5 (For this type, set 'surf' to none, and 'toothValue' to 1)
  • Bleeding: 6 (Sum of flags for bleeding(1), suppuration(2), plaque(4), and calculus(8))
  • CAL: 7 (This type is never saved to the DB; it is always calculated on the fly)
Enum01234567
Example: 4
intToothnumberrequired

Valid values are 1-32. Every measurement must be associated with a tooth.

toothValuenumberrequired

This is used when the measurement does not apply to a surface(mobility and skiptooth). Valid values for all surfaces are 0 through 19, or -1 to represent no measurement taken.

mBvaluenumberrequired

1 represents no measurement. Values of 100+ represent negative values (only used for Gingival Margins). e.g. To use a value of 105, subtract it from 100. (100 - 105 = -5)

bvaluenumberrequired

Buccal value

dBvaluenumberrequired

Distal-buccal value

mLvaluenumberrequired

Mesial-lingual value

dLvaluenumberrequired

Distal-lingual value

secDateTEntrystring(date-time)required

Timestamp automatically generated and user not allowed to change. The actual date of entry.

secDateTEditstring(date-time)required

Timestamp for last edit

idnumberrequired

The ID of the site periomeasure to be updated

Example: 100
createdAtstringrequired

The date and time the site periomeasure was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the site periomeasure was last updated

Example: "2021-08-01T00:00:00.000Z"
]
Response
application/json
[
  {
    "siteId": 0,
    "practitionerId": 0,
    "patientId": 0,
    "perioMeasureNum": 0,
    "perioExamNum": 0,
    "sequenceType": 4,
    "intTooth": 0,
    "toothValue": 0,
    "mBvalue": 0,
    "bvalue": 0,
    "dBvalue": 0,
    "mLvalue": 0,
    "dLvalue": 0,
    "secDateTEntry": "2019-08-24T14:15:22Z",
    "secDateTEdit": "2019-08-24T14:15:22Z",
    "id": 100,
    "createdAt": "2021-08-01T00:00:00.000Z",
    "updatedAt": "2021-08-01T00:00:00.000Z"
  }
]

Create Sites Periomeasure

Request

Bodyapplication/jsonrequired
siteIdnumberrequired

The ID of the site associated with this periomeasure

practitionerIdnumberrequired

The ID of the FHIR Practitioner associated with this periomeasure

patientIdnumberrequired

The ID of the FHIR Patiend associated with this periomeasure

perioMeasureNumnumberrequired

Periomeasure number

perioExamNumnumberrequired

Periomeasure exam number

sequenceTypenumberrequired

Enum: PerioSequenceType. Possible values are:

  • Mobility: 0
  • Furcation: 1
  • GingMargin: 2 (AKA recession)
  • MGJ: 3 (MucoGingivalJunction - the division between attached and unattached mucosa)
  • Probing: 4
  • SkipTooth: 5 (For this type, set 'surf' to none, and 'toothValue' to 1)
  • Bleeding: 6 (Sum of flags for bleeding(1), suppuration(2), plaque(4), and calculus(8))
  • CAL: 7 (This type is never saved to the DB; it is always calculated on the fly)
Enum01234567
Example: 4
intToothnumberrequired

Valid values are 1-32. Every measurement must be associated with a tooth.

toothValuenumberrequired

This is used when the measurement does not apply to a surface(mobility and skiptooth). Valid values for all surfaces are 0 through 19, or -1 to represent no measurement taken.

mBvaluenumberrequired

1 represents no measurement. Values of 100+ represent negative values (only used for Gingival Margins). e.g. To use a value of 105, subtract it from 100. (100 - 105 = -5)

bvaluenumberrequired

Buccal value

dBvaluenumberrequired

Distal-buccal value

mLvaluenumberrequired

Mesial-lingual value

dLvaluenumberrequired

Distal-lingual value

secDateTEntrystring(date-time)required

Timestamp automatically generated and user not allowed to change. The actual date of entry.

secDateTEditstring(date-time)required

Timestamp for last edit

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/periomeasure' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": 0,
    "practitionerId": 0,
    "patientId": 0,
    "perioMeasureNum": 0,
    "perioExamNum": 0,
    "sequenceType": 4,
    "intTooth": 0,
    "toothValue": 0,
    "mBvalue": 0,
    "bvalue": 0,
    "dBvalue": 0,
    "mLvalue": 0,
    "dLvalue": 0,
    "secDateTEntry": "2019-08-24T14:15:22Z",
    "secDateTEdit": "2019-08-24T14:15:22Z"
  }'

Responses

Periomeasures created successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this periomeasure

practitionerIdnumberrequired

The ID of the FHIR Practitioner associated with this periomeasure

patientIdnumberrequired

The ID of the FHIR Patiend associated with this periomeasure

perioMeasureNumnumberrequired

Periomeasure number

perioExamNumnumberrequired

Periomeasure exam number

sequenceTypenumberrequired

Enum: PerioSequenceType. Possible values are:

  • Mobility: 0
  • Furcation: 1
  • GingMargin: 2 (AKA recession)
  • MGJ: 3 (MucoGingivalJunction - the division between attached and unattached mucosa)
  • Probing: 4
  • SkipTooth: 5 (For this type, set 'surf' to none, and 'toothValue' to 1)
  • Bleeding: 6 (Sum of flags for bleeding(1), suppuration(2), plaque(4), and calculus(8))
  • CAL: 7 (This type is never saved to the DB; it is always calculated on the fly)
Enum01234567
Example: 4
intToothnumberrequired

Valid values are 1-32. Every measurement must be associated with a tooth.

toothValuenumberrequired

This is used when the measurement does not apply to a surface(mobility and skiptooth). Valid values for all surfaces are 0 through 19, or -1 to represent no measurement taken.

mBvaluenumberrequired

1 represents no measurement. Values of 100+ represent negative values (only used for Gingival Margins). e.g. To use a value of 105, subtract it from 100. (100 - 105 = -5)

bvaluenumberrequired

Buccal value

dBvaluenumberrequired

Distal-buccal value

mLvaluenumberrequired

Mesial-lingual value

dLvaluenumberrequired

Distal-lingual value

secDateTEntrystring(date-time)required

Timestamp automatically generated and user not allowed to change. The actual date of entry.

secDateTEditstring(date-time)required

Timestamp for last edit

idnumberrequired

The ID of the site periomeasure to be updated

Example: 100
createdAtstringrequired

The date and time the site periomeasure was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the site periomeasure was last updated

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "siteId": 0,
  "practitionerId": 0,
  "patientId": 0,
  "perioMeasureNum": 0,
  "perioExamNum": 0,
  "sequenceType": 4,
  "intTooth": 0,
  "toothValue": 0,
  "mBvalue": 0,
  "bvalue": 0,
  "dBvalue": 0,
  "mLvalue": 0,
  "dLvalue": 0,
  "secDateTEntry": "2019-08-24T14:15:22Z",
  "secDateTEdit": "2019-08-24T14:15:22Z",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z"
}

Retrieve Sites Periomeasure By Id

Request

Path
sitePeriomeasureIdnumberrequired
siteIdnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/periomeasure/{sitePeriomeasureId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of Sites all Periomeasure retrieved successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this periomeasure

practitionerIdnumberrequired

The ID of the FHIR Practitioner associated with this periomeasure

patientIdnumberrequired

The ID of the FHIR Patiend associated with this periomeasure

perioMeasureNumnumberrequired

Periomeasure number

perioExamNumnumberrequired

Periomeasure exam number

sequenceTypenumberrequired

Enum: PerioSequenceType. Possible values are:

  • Mobility: 0
  • Furcation: 1
  • GingMargin: 2 (AKA recession)
  • MGJ: 3 (MucoGingivalJunction - the division between attached and unattached mucosa)
  • Probing: 4
  • SkipTooth: 5 (For this type, set 'surf' to none, and 'toothValue' to 1)
  • Bleeding: 6 (Sum of flags for bleeding(1), suppuration(2), plaque(4), and calculus(8))
  • CAL: 7 (This type is never saved to the DB; it is always calculated on the fly)
Enum01234567
Example: 4
intToothnumberrequired

Valid values are 1-32. Every measurement must be associated with a tooth.

toothValuenumberrequired

This is used when the measurement does not apply to a surface(mobility and skiptooth). Valid values for all surfaces are 0 through 19, or -1 to represent no measurement taken.

mBvaluenumberrequired

1 represents no measurement. Values of 100+ represent negative values (only used for Gingival Margins). e.g. To use a value of 105, subtract it from 100. (100 - 105 = -5)

bvaluenumberrequired

Buccal value

dBvaluenumberrequired

Distal-buccal value

mLvaluenumberrequired

Mesial-lingual value

dLvaluenumberrequired

Distal-lingual value

secDateTEntrystring(date-time)required

Timestamp automatically generated and user not allowed to change. The actual date of entry.

secDateTEditstring(date-time)required

Timestamp for last edit

idnumberrequired

The ID of the site periomeasure to be updated

Example: 100
createdAtstringrequired

The date and time the site periomeasure was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the site periomeasure was last updated

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "siteId": 0,
  "practitionerId": 0,
  "patientId": 0,
  "perioMeasureNum": 0,
  "perioExamNum": 0,
  "sequenceType": 4,
  "intTooth": 0,
  "toothValue": 0,
  "mBvalue": 0,
  "bvalue": 0,
  "dBvalue": 0,
  "mLvalue": 0,
  "dLvalue": 0,
  "secDateTEntry": "2019-08-24T14:15:22Z",
  "secDateTEdit": "2019-08-24T14:15:22Z",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z"
}

Update an existing Sites Periomeasure

Request

Path
sitePeriomeasureIdnumberrequired
Bodyapplication/jsonrequired
siteIdnumberrequired

The ID of the site associated with this periomeasure

practitionerIdnumberrequired

The ID of the FHIR Practitioner associated with this periomeasure

patientIdnumberrequired

The ID of the FHIR Patiend associated with this periomeasure

perioMeasureNumnumberrequired

Periomeasure number

perioExamNumnumberrequired

Periomeasure exam number

sequenceTypenumberrequired

Enum: PerioSequenceType. Possible values are:

  • Mobility: 0
  • Furcation: 1
  • GingMargin: 2 (AKA recession)
  • MGJ: 3 (MucoGingivalJunction - the division between attached and unattached mucosa)
  • Probing: 4
  • SkipTooth: 5 (For this type, set 'surf' to none, and 'toothValue' to 1)
  • Bleeding: 6 (Sum of flags for bleeding(1), suppuration(2), plaque(4), and calculus(8))
  • CAL: 7 (This type is never saved to the DB; it is always calculated on the fly)
Enum01234567
Example: 4
intToothnumberrequired

Valid values are 1-32. Every measurement must be associated with a tooth.

toothValuenumberrequired

This is used when the measurement does not apply to a surface(mobility and skiptooth). Valid values for all surfaces are 0 through 19, or -1 to represent no measurement taken.

mBvaluenumberrequired

1 represents no measurement. Values of 100+ represent negative values (only used for Gingival Margins). e.g. To use a value of 105, subtract it from 100. (100 - 105 = -5)

bvaluenumberrequired

Buccal value

dBvaluenumberrequired

Distal-buccal value

mLvaluenumberrequired

Mesial-lingual value

dLvaluenumberrequired

Distal-lingual value

secDateTEntrystring(date-time)required

Timestamp automatically generated and user not allowed to change. The actual date of entry.

secDateTEditstring(date-time)required

Timestamp for last edit

idnumberrequired

The ID of the site periomeasure to be updated

Example: 100
createdAtstringrequired

The date and time the site periomeasure was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the site periomeasure was last updated

Example: "2021-08-01T00:00:00.000Z"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/periomeasure/{sitePeriomeasureId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": 0,
    "practitionerId": 0,
    "patientId": 0,
    "perioMeasureNum": 0,
    "perioExamNum": 0,
    "sequenceType": 4,
    "intTooth": 0,
    "toothValue": 0,
    "mBvalue": 0,
    "bvalue": 0,
    "dBvalue": 0,
    "mLvalue": 0,
    "dLvalue": 0,
    "secDateTEntry": "2019-08-24T14:15:22Z",
    "secDateTEdit": "2019-08-24T14:15:22Z",
    "id": 100,
    "createdAt": "2021-08-01T00:00:00.000Z",
    "updatedAt": "2021-08-01T00:00:00.000Z"
  }'

Responses

Site Periomeasure updated successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this periomeasure

practitionerIdnumberrequired

The ID of the FHIR Practitioner associated with this periomeasure

patientIdnumberrequired

The ID of the FHIR Patiend associated with this periomeasure

perioMeasureNumnumberrequired

Periomeasure number

perioExamNumnumberrequired

Periomeasure exam number

sequenceTypenumberrequired

Enum: PerioSequenceType. Possible values are:

  • Mobility: 0
  • Furcation: 1
  • GingMargin: 2 (AKA recession)
  • MGJ: 3 (MucoGingivalJunction - the division between attached and unattached mucosa)
  • Probing: 4
  • SkipTooth: 5 (For this type, set 'surf' to none, and 'toothValue' to 1)
  • Bleeding: 6 (Sum of flags for bleeding(1), suppuration(2), plaque(4), and calculus(8))
  • CAL: 7 (This type is never saved to the DB; it is always calculated on the fly)
Enum01234567
Example: 4
intToothnumberrequired

Valid values are 1-32. Every measurement must be associated with a tooth.

toothValuenumberrequired

This is used when the measurement does not apply to a surface(mobility and skiptooth). Valid values for all surfaces are 0 through 19, or -1 to represent no measurement taken.

mBvaluenumberrequired

1 represents no measurement. Values of 100+ represent negative values (only used for Gingival Margins). e.g. To use a value of 105, subtract it from 100. (100 - 105 = -5)

bvaluenumberrequired

Buccal value

dBvaluenumberrequired

Distal-buccal value

mLvaluenumberrequired

Mesial-lingual value

dLvaluenumberrequired

Distal-lingual value

secDateTEntrystring(date-time)required

Timestamp automatically generated and user not allowed to change. The actual date of entry.

secDateTEditstring(date-time)required

Timestamp for last edit

idnumberrequired

The ID of the site periomeasure to be updated

Example: 100
createdAtstringrequired

The date and time the site periomeasure was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the site periomeasure was last updated

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "siteId": 0,
  "practitionerId": 0,
  "patientId": 0,
  "perioMeasureNum": 0,
  "perioExamNum": 0,
  "sequenceType": 4,
  "intTooth": 0,
  "toothValue": 0,
  "mBvalue": 0,
  "bvalue": 0,
  "dBvalue": 0,
  "mLvalue": 0,
  "dLvalue": 0,
  "secDateTEntry": "2019-08-24T14:15:22Z",
  "secDateTEdit": "2019-08-24T14:15:22Z",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z"
}

Delete a Site Periomeasure by its ID

Request

Path
sitePeriomeasureIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/periomeasure/{sitePeriomeasureId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site Periomeasure deleted successfully.

Response
application/json
{
  "message": "Unauthorized",
  "statusCode": 401
}