Merge pull request #481 from cookeac/454-extended-reason-codes

Add extended reason codes
adewg · Aug 8, 2024 · d2412a4 · d2412a4
2 parents d35ada8 + 06870b7
commit d2412a4
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 2 deletions.
diff --git a/resources/icarMovementDeathEventResource.json b/resources/icarMovementDeathEventResource.json
@@ -1,5 +1,5 @@
 {
-  "description": "Event for recording animal death",
+  "description": "Event for recording animal death on farm.",
 
   "allOf": [{
       "$ref": "../resources/icarAnimalEventCoreResource.json"
@@ -35,6 +35,13 @@
         "deathMethod": {
           "$ref": "../enums/icarDeathMethodType.json",
           "description": "Defines the method of death, including an accident, natural causes, or euthanised."
+        },
+        "extendedReasons": {
+          "description": "Extended reason codes why this animal has died.",
+          "type": "array",
+          "items": {
+            "$ref": "../types/icarReasonIdentifierType.json"
+          }
         }        
       }
     }

diff --git a/resources/icarMovementDepartureEventResource.json b/resources/icarMovementDepartureEventResource.json
@@ -1,5 +1,5 @@
 {
-  "description": "Event for recording animal departure",
+  "description": "Event for recording live animal departure.",
 
   "allOf": [{
       "$ref": "../resources/icarAnimalEventCoreResource.json"
@@ -19,6 +19,13 @@
         "consignment": {
           "$ref": "../types/icarConsignmentType.json",
           "description": "Identifies the consignment of the animal from the holding."
+        },
+        "extendedReasons": {
+          "description": "Extended reason codes why this animal has departed.",
+          "type": "array",
+          "items": {
+            "$ref": "../types/icarReasonIdentifierType.json"
+          }
         }
       }
     }

diff --git a/resources/icarReproDoNotBreedEventResource.json b/resources/icarReproDoNotBreedEventResource.json
@@ -11,6 +11,13 @@
           "type": ["boolean", "null"],
           "description": "Set this attribute to true if the animal should not be bred, false if it may now be bred.",
           "default": true
+        },
+        "extendedReasons": {
+          "description": "Extended reason codes why this animal should not be bred.",
+          "type": "array",
+          "items": {
+            "$ref": "../types/icarReasonIdentifierType.json"
+          }
         }
       }
     }

diff --git a/types/icarReasonIdentifierType.json b/types/icarReasonIdentifierType.json
@@ -0,0 +1,7 @@
+{
+  "description": "Extended reason identifier based on a scheme and ID.",
+
+  "allOf": [{
+    "$ref": "../types/icarIdentifierType.json"
+  }]
+}
diff --git a/well-known/icarReasonIdentifierType.md b/well-known/icarReasonIdentifierType.md
@@ -0,0 +1,6 @@
+# Well-known Extended Reason Identifier Schemes
+
+These schemes define country, region, or species-specific extended reason codes for departures, deaths, and do not breed events. If you represent a recording organisation or scheme operator, please edit and "Pull Request" this file to let others know about your extended reason code schemes.
+
+| Short URI | Resolvable URI | Description | Example | Code list or format specification |
+| --- | --- | --- | --- | --- |