icarGroupTreatmentEventResource

Description

Defines a health treatment applied to a group of animals.

The icarGroupTreatmentEventResource schema inherits from icarGroupEventCoreResource.

Properties

Name	Description	Required	Type
Medicine	A reference to the medicine used (where applicable).	No	icarMedicineReferenceType
Procedure	Medicine application method or a non-medicine procedure.	No	string
Batches	Batches and expiry details for the medicine administered.	No	Array of  icarMedicineBatchType
Withdrawals	Withholding details for the treatment administered.	No	Array of  icarMedicineWithdrawalType
DosePerAnimal	The actual or average medicine dose administered per animal.	No	icarMedicineDoseType
TotalMedicineUsed	The total amount of medicine used.	No	icarMedicineDoseType
Site	Body site where the treatment was administered.	No	string
Positions	The positions to be treated	No	Array of  icarPositionType
GroupMethod	Indicates whether the event references an existing animal set, has an embedded animal set, or an inventory classification.	Yes	icarGroupEventMethodType
CountObserved	Summarises the number of animals observed in the event. Generally the number of animals in the group, but sometimes a sample.	No	Integer
InventoryClassification	Describe the group of animals by their characteristics rather than animal identifiers.	No	icarInventoryClassificationType
EmbeddedAnimalSet	Specifies the set of animals as a list of member animal identifiers.	No	icarAnimalSetResource
AnimalSetReference	Reference an existing animal set by ID and optionally URI	No	icarResourceReferenceType
Id	Unique identifier in the source system for this event.	No	string
EventDateTime	RFC3339 UTC date and time (see https://ijmacd.github.io/rfc3339-iso8601/).	No	date-time
TraitLabel	If the event represents a formal trait, identifies the recording system and trait.	No	icarIdentifierType
Responsible	Use if an observation is manually recorded, or an event is carried out or authorised by a person. SHOULD be a person object.	No	string
ContemporaryGroup	For manually recorded events, record any contemporary group code that would affect statistical analysis.	No	string
Remark	A comment or remark field for additional user-specified information about the event.	No	string
Self	Uniform resource identifier (URI) of the resource (rel=self).	No	string
Meta	Meta-data for the resource. Mandatory if you wish to support synchronisation.	No	icarMetaDataType
Location	Unique location scheme and identifier combination.	No	icarIdentifierType

Examples

Example 1

{
  "medicine": {
    "name": "name",
    "approved": "approved",
    "registeredIdentifier": {
      "id": "id",
      "scheme": "scheme"
    },
    "@context": "@context",
    "@id": "@id",
    "@type": "Link",
    "identifier": {
      "id": "id",
      "scheme": "scheme"
    },
    "reltype": "reltype",
    "href": "href"
  },
  "procedure": "procedure",
  "batches": [
    {
      "identifier": "identifier",
      "expiryDate": "2024-12-04T20:18:42.6533186+00:00"
    }
  ],
  "withdrawals": [
    {
      "productType": "Meat",
      "endDate": "2024-12-04T20:18:42.6533238+00:00",
      "market": "market"
    }
  ],
  "dosePerAnimal": {
    "doseQuantity": 0.0,
    "doseUnits": "MLT"
  },
  "totalMedicineUsed": {
    "doseQuantity": 0.0,
    "doseUnits": "MLT"
  },
  "site": "site",
  "positions": [
    {
      "position": "LegsFrontLeft"
    }
  ],
  "groupMethod": "ExistingAnimalSet",
  "countObserved": 0,
  "inventoryClassification": {
    "name": "name",
    "count": 0.0,
    "species": "Buffalo",
    "sex": "Female",
    "primaryBreed": {
      "id": "id",
      "scheme": "scheme"
    },
    "birthPeriod": "birthPeriod",
    "reproductiveStatus": "Open",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Meat"
    ]
  },
  "embeddedAnimalSet": {
    "id": "id",
    "name": "name",
    "purpose": "Enclosure",
    "member": [
      {
        "id": "id",
        "scheme": "scheme"
      }
    ],
    "resourceType": "resourceType",
    "@self": "@self",
    "meta": {
      "source": "source",
      "sourceId": "sourceId",
      "isDeleted": false,
      "modified": "2024-12-04T20:18:42.6532480+00:00",
      "created": "2024-12-04T20:18:42.6532495+00:00",
      "creator": "creator",
      "validFrom": "2024-12-04T20:18:42.6532515+00:00",
      "validTo": "2024-12-04T20:18:42.6532527+00:00"
    },
    "location": {
      "id": "id",
      "scheme": "scheme"
    }
  },
  "animalSetReference": {
    "@context": "@context",
    "@id": "@id",
    "@type": "Link",
    "identifier": {
      "id": "id",
      "scheme": "scheme"
    },
    "reltype": "reltype",
    "href": "href"
  }
}