Skip to content

Create practitioner

Request

Creates a new Practitioner record. A veterinary professional (veterinarian, technician, nurse).

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
practitionerIdstring

Canonical unique identifier for the practitioner.

Example:"123e4567-e89b-12d3-a456-426614174000"
userIdstring

Reference to the associated user account.

Example:"123e4567-e89b-12d3-a456-426614174000"
licenseNumberstring

Professional license number.

Example:"example"
licenseStatestring

State/jurisdiction of license.

Example:"https://example.com"
roleobject(CodeableConceptDto)

Professional role (veterinarian, technician, nurse, specialist).

specialtiesArray of objects(SpecialtieDto)

List of specialties (surgery, dentistry, oncology).

facilityIdsArray of strings

Facilities where this practitioner works.

isActiveboolean

Whether the practitioner is currently active.

Example:true
extensionsobject

Vendor- or practice-specific extensions.

curl -i -X POST \
  'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/practitioner' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "practitionerId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "licenseNumber": "example",
    "licenseState": "https://example.com",
    "role": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "specialties": [
      {
        "code": "example",
        "system": "example",
        "display": "example"
      }
    ],
    "facilityIds": [
      "string"
    ],
    "isActive": true,
    "extensions": {}
  }'

Responses

Practitioner created successfully

Bodyapplication/json
practitionerIdstringrequired

Canonical unique identifier for the practitioner.

Example:"123e4567-e89b-12d3-a456-426614174000"
userIdstringrequired

Reference to the associated user account.

Example:"123e4567-e89b-12d3-a456-426614174000"
licenseNumberstringrequired

Professional license number.

Example:"example"
licenseStatestringrequired

State/jurisdiction of license.

Example:"https://example.com"
roleobject(CodeableConceptDto)required

Professional role (veterinarian, technician, nurse, specialist).

specialtiesArray of objects(SpecialtieDto)required

List of specialties (surgery, dentistry, oncology).

facilityIdsArray of stringsrequired

Facilities where this practitioner works.

isActivebooleanrequired

Whether the practitioner is currently active.

Example:true
createdAtstring, (date-time)required

Timestamp when the practitioner record was created.

Example:"2025-01-01T00:00:00.000Z"
updatedAtstring, (date-time)required

Timestamp when the practitioner record was last updated.

Example:"2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extensions.

Response
{ "practitionerId": "123e4567-e89b-12d3-a456-426614174000", "userId": "123e4567-e89b-12d3-a456-426614174000", "licenseNumber": "example", "licenseState": "https://example.com", "role": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "specialties": [ { … } ], "facilityIds": [ "string" ], "isActive": true, "createdAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "extensions": {} }