Identifier Mappings

Map legacy integer sequential ids to NexGen UUIDs for supported resource types (patient, practitioner, appointment, invoice), up to 100 ids per request.

Operations

Map legacy ids to UUIDs

Request

Maps legacy integer sequential ids to their UUID values for the practice identified by X-Practice-Id.

The request must include:

resource — one of patient, practitioner, appointment, or invoice
ids — between 1 and 100 inclusive legacy integer ids

The response contains a mapping only for ids that match a record. Requested ids with no match are omitted.

Security

oauth2(Required scopes: identifier_mapping:read)

X-Practice-Idstring, (uuid)required

UUID of the practice in whose context the request is executed. The API uses this to resolve data the caller is permitted to access for that practice.

Bodyapplication/jsonrequired

Legacy identifiers to map.

resourcestringrequired

The NexGen resource type to map identifiers for. Supported values are patient, practitioner, appointment, and invoice.

Enum:"patient""practitioner""appointment""invoice"

idsArray of integers, [ 1 .. 100 ] itemsrequired

Legacy integer sequential ids to map. Between 1 and 100 ids must be supplied. Each value must be a numeric sequential id for the requested resource.

curl -i -X POST \
  https://docs.api.dentally.com/_mock/docs/versions/2026-01-01/nexgen/identifier_mappings \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Practice-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -d '{
    "resource": "patient",
    "ids": [
      42,
      43
    ]
  }'

Responses

Mapped identifiers.

Bodyapplication/json

dataArray of objects, <= 100 items(identifier-mapping)required

Mappings for requested ids that matched a record. Ids with no match are omitted.

Response

{
  "data": [
    { … }
  ]
}