1. Home
  2. /
  3. Resource Types
  4. /
  5. Livestock
  6. /
  7. Livestock Treatments
  8. /
  9. Animal Treatment Event

Resource Type: Livestock – Animal Treatment Event

URLs

Get all animal treatment events that you have access to

GET /data/livestock/treatment/animal-treatment-events

Get a single animal treatment event

GET /data/livestock/treatment/animal-treatment-events/{treatmentId}

Get all animal treatment events associated with a holding

GET ​/data/holdings/{HoldingId}/livestock/treatment/animal-treatment-events

Get a single animal treatment event associated with a holding

GET /data/holdings/{HoldingId}/livestock/treatment/animal-treatment-events/{treatmentId}

Response Structure

Note: The animal treatment event endpoints with multiple entries are paginated, please see Pagination for more details.

A call to the animal treatment event endpoints returns the following fields.

{
    "@self": "string",
    "location": {...},
    "meta": {...},  
    "resourceType": "/livestock/treatment/animal-treatment-event",
    "id": "string",
    "eventDateTime": "2022-12-14T01:52:01.454Z",
    "traitLabel": {...},
    "responsible": "string",
    "contemporaryGroup": "string",
    "remark": "string",  
    "animal": {...},
    "procedure": "string",
    "site": "string",
    "comment": "string",
    "medicine": {...},
    "dose": {...},
    "positions": [...],
    "batches": [...],
    "withdrawals": [...],
}
Response Item Description Data Type
Self A link to this specific Animal Treatment Event. URI
Location An identifier for the location of the Animal Treatment Event. Identifier
Meta Meta data for the resource. Metadata
Resource Type The fixed discriminator for the Animal Treatment Event resource type.
Value: /livestock/treatment/animal-treatment-event		 String
Id The Pure Farming Id of this Animal Treatment Event. UUID
Event Date Time A particular point in the progression of time. DateTimeOffset
Trait Label Represents a formal trait, identifies the recording system and trait. Identifier
Responsible Use if an observation is manually recorded, or an event is carried out or authorised by a person. String
Contemporary Group For manually recorded events, record any contemporary group code that would affect statistical analysis. String
Remark A comment or remark field for additional user-specified information about the event. String
Animal Unique animal scheme and identifier combination. Identifier
Procedure Medicine application method or a non-medicine procedure. String
Site Body site where the treatment was administered. String
Comment A comment recorded about the treatment or its outcome. String
Medicine A reference to the medicine used (where applicable). Medicine
Dose Details of medicine dose administered. Dose
Positions The possible positions for treatment or diagnosis. Array of Enumeration
Batches Defines a batch of medicine or product with an expiry date. Array of Batches
Withdrawals Withholding details for the treatment administered. Array of Withdrawals

Medicine

The medication used for treatment of the animals

{
  "identifier": {...},
  "name": "string",
  "registeredIdentifier": {...},
  "approved": "string",
  "reltype": "string",
  "href": "string"
}
Response Item Description Data Type
Identifier Identifies a resource Identifier
Name Name of the medicine or remedy given for this treatment String
Registered Identifier Identifies a medicine registraton with a national Scheme and a registered ID within that scheme Array of Identifier
Approved An indicator whether the medicine or remedy is an approved medicine String
Reltype Defines the relationship between the current resource and the referenced resource. Defined in well-known/relationshipCatalog.md String
Href Where provided, this is the URI to the medication information page URI

Dose

Details of medicine dose administered.

{
  "doseQuantity": 27.5,
  "doseUnits": "string"
}
Response Item Description Data Type
Dose Quantity Quantity of medicine or product administered Number
Dose Units Units of measurement in UN/CEFACT 3-letter form
(Valid values: MLT, LTR, MGM, GRM, XTU, XVI, XAR, XCQ, GJ, GL, GRN, L19, NA, SYR, WW)		 Enumeration

Batches

Batches and expiry details for the medicine administered

[
  {
    "identifier": "string",
    "expiryDate": "2024-06-16T00:00:00.000Z"
  }
]
Response Item Description Data Type
Identifier The ID, batch or lot number String
Expiry Date A particular point in the progression of time. Datetime

Withdrawals

Withholding details for the treatment administered

[
  {
    "productType": "string",
    "endDate": "2022-10-31T17:06:00.000Z",
    "market": "string"
  }
]
Response Item Description Data Type
Product Type Product or food item affected by this withdrawal.
(Valid values: Meat, Milk, Eggs, Honey, Velvet, Fibre, Other)		 Enumeration
End Date A particular point in the progression of time. Datetime
Market The market to which the withdrawal applies, using a scheme such as au.gov.apvma.esi or au.gov.apvma.whp String

Enumerations

Type: Position

Values:

  • LegsFrontLeft
  • LegsFrontRight
  • LegsRearLeft
  • LegsRearRight
  • UdderFrontLeft
  • UdderFrontRight
  • UdderRearLeft
  • UdderRearRight
  • OvariesLeft
  • OvariesRight
  • OvariesUnknown
  • Neck
  • Head
  • Mouth
  • Back
  • Testes
  • Other