icarProgenyDetailsResource.json

{
  "description": "Schema for representing progeny details",
  
  "allOf": [
    {
      "$ref": "../resources/icarResource.json"
    },

    {
      "type": "object",
      "required": [
        "specie",
        "gender"
      ],

      "properties": {
        "identifier": {
          "description": "Unique animal scheme and identifier combination.",
          "type": ["object", "null"],
          "allOf": [
            {
              "$ref": "../types/icarAnimalIdentifierType.json"
            }
          ]
        },
        "alternativeIdentifiers": {
          "type": ["array","null"],
          "items": {
            "$ref": "../types/icarAnimalIdentifierType.json"
          },
          "description": "Alternative identifiers for the animal. Here, also temporary identifiers, e.g. transponders or animal numbers, can be listed."
        },
        "specie": {
          "$ref": "../enums/icarAnimalSpecieType.json",
          "description": "Species of the animal."
        },
        "gender": {
          "$ref": "../enums/icarAnimalGenderType.json",
          "description": "Gender of the animal."
        },
        "managementTag": {
          "type": ["string", "null"],
          "description": "The identifier used by the farmer in day to day operations. In many cases this could be the animal number."
        },
        "name": {
          "type": "string",
          "description": "Name given by the farmer for this animal."
        },
        "officialName": {
          "type": "string",
          "description": "Official herdbook name."
        },
        "taggingDate": {
          "description": "Progeny tagging date in RFC3339 UTC (see https://ijmacd.github.io/rfc3339-iso8601/ for format guidance).",
          "type": ["string", "null"],
          "allOf": [
            {
              "$ref": "../types/icarDateTimeType.json"
            }
          ]
        },
        "birthStatus": {
          "description": "Birth status of the progeny.",
          "type": ["string", "null"],
          "allOf": [
            {
              "$ref": "../enums/icarParturitionBirthStatusType.json"
            }
          ]
        },
        "birthSize": {
          "description": "Size of the progeny.",
          "type": ["string", "null"],
          "allOf": [
            {
              "$ref": "../enums/icarParturitionBirthSizeType.json"
            }
          ]
        },
        "birthWeight": {
          "description": "Weight of the progeny.",
          "type": ["object", "null"],
          "allOf": [
            {
              "$ref": "../types/icarMassMeasureType.json"
            }
          ]
        }
      }
    }
  ]
}