icarTreatmentProgramEventResource

Description

An animal health event combining diagnosis and planned or actual treatment course or events.

The icarTreatmentProgramEventResource schema inherits from icarAnimalEventCoreResource.

Properties

Name	Description	Required	Type
Diagnoses	Decribes the diagnosis of one or more conditions	No	Array of  icarDiagnosisType
Courses	Details the course of treatments at a summary (start and end date) level. The array allows for different medicines/procedures.	No	Array of  icarMedicineCourseSummaryType
Treatments	The list of the treatments (medicines or procedures) applied.	No	Array of  icarTreatmentEventResource
Animal	Unique animal scheme and identifier combination.	Yes	icarIdentifierType
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

{
  "diagnoses": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "diagnosisCode": {
        "id": "id",
        "scheme": "scheme"
      },
      "site": "site",
      "stage": "Early",
      "severity": "Light",
      "severityScore": 0.0,
      "positions": [
        {
          "position": "LegsFrontLeft"
        }
      ]
    }
  ],
  "courses": [
    {
      "startDate": "2024-09-22T22:56:34.0733596+00:00",
      "endDate": "2024-09-22T22:56:34.0733611+00:00",
      "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",
      "site": "site",
      "reasonForAdministration": "reasonForAdministration",
      "totalDose": {
        "doseQuantity": 0.0,
        "doseUnits": "MLT"
      },
      "numberOfTreatments": 0.0,
      "treatmentInterval": 0,
      "batches": [
        {
          "identifier": "identifier",
          "expiryDate": "2024-09-22T22:56:34.0734034+00:00"
        }
      ],
      "planOrActual": "Plan",
      "withdrawals": [
        {
          "productType": "Meat",
          "endDate": "2024-09-22T22:56:34.0734103+00:00",
          "market": "market"
        }
      ]
    }
  ],
  "treatments": [
    {
      "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-09-22T22:56:34.0735105+00:00"
        }
      ],
      "withdrawals": [
        {
          "productType": "Meat",
          "endDate": "2024-09-22T22:56:34.0735158+00:00",
          "market": "market"
        }
      ],
      "dose": {
        "doseQuantity": 0.0,
        "doseUnits": "MLT"
      },
      "site": "site",
      "positions": [
        {
          "position": "LegsFrontLeft"
        }
      ],
      "comment": "comment",
      "animal": {
        "id": "id",
        "scheme": "scheme"
      }
    }
  ],
  "animal": {
    "id": "id",
    "scheme": "scheme"
  }
}