Skip to content

Create breed

Request

Creates a new Breed record. Breed resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
breedIdstring

Canonical unique identifier for the breed.

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

Vendor- or practice-specific extensions. Keys SHOULD be namespaced (e.g., vendorName.extensionName) to avoid collisions. Values SHOULD be primitive JSON types or small nested objects that do not duplicate core AHDS fields.

isActivebooleanrequired

Whether this breed is currently active and can be selected for new records in the system. Inactive breeds should remain for historical/reference purposes but should not be used for new assignments.

Example:true
namestringrequired

Human-readable name of the breed.

Example:"Example Name"
speciesIdstringrequired

Reference to the species this breed belongs to.

Example:"123e4567-e89b-12d3-a456-426614174000"
codeobject(CodeableConceptDto)required

Primary coded representation of the breed using the AHDS CodeableConcept pattern (e.g., standardized breed code from a terminology such as SNOMED CT or a veterinary breed registry).

breedCodeobject(CodeableConceptDto)

Primary coded representation of the breed using a CodeableConcept structure. Intended for interoperable coding of breeds across systems and terminologies.

curl -i -X POST \
  'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/breed' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "breedId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "Example Name",
    "speciesId": "123e4567-e89b-12d3-a456-426614174000",
    "code": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "breedCode": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Breed created successfully

Bodyapplication/json
breedIdstringrequired

Canonical unique identifier for the breed.

Example:"123e4567-e89b-12d3-a456-426614174000"
createdAtstring, (date-time)required

Timestamp when the breed record was created.

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

Vendor- or practice-specific extensions. Keys SHOULD be namespaced (e.g., vendorName.extensionName) to avoid collisions. Values SHOULD be primitive JSON types or small nested objects that do not duplicate core AHDS fields.

isActivebooleanrequired

Whether this breed is currently active and can be selected for new records in the system. Inactive breeds should remain for historical/reference purposes but should not be used for new assignments.

Example:true
namestringrequired

Human-readable name of the breed.

Example:"Example Name"
speciesIdstringrequired

Reference to the species this breed belongs to.

Example:"123e4567-e89b-12d3-a456-426614174000"
updatedAtstring, (date-time)required

Timestamp when the breed record was last updated.

Example:"2025-01-01T00:00:00.000Z"
codeobject(CodeableConceptDto)required

Primary coded representation of the breed using the AHDS CodeableConcept pattern (e.g., standardized breed code from a terminology such as SNOMED CT or a veterinary breed registry).

breedCodeobject(CodeableConceptDto)required

Primary coded representation of the breed using a CodeableConcept structure. Intended for interoperable coding of breeds across systems and terminologies.

Response
{ "breedId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "Example Name", "speciesId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "code": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "breedCode": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" } }