Coding Event 📝
Official URL: https://bcgov.github.io/nr-pies/docs/spec/element/resource/coding_event
JSON Schema URL: https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/resource/coding_event.schema.json
Represents a coding concept at a specific event in time.
Scope
This data type is intended to represent an instance of a temporal event within a defined coding.
Loosely taking inspiration from HL7 Timing.
Structure
| Name | Cardinality | Type | Description & Constraints |
|---|---|---|---|
| coding | 1..1 | Coding | A coding concept. This attribute should represent the core concept of a defined coding. |
| event | 1..1 | Event | An event concept. This attribute should solely describe the raw known factual information a specific temporal event. |
Specification
- Schema
- Source
- Example
Loading ....
{
"$id": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/resource/coding_event.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Coding Event",
"description": "Represents a coding concept at a specific event in time.",
"type": "object",
"properties": {
"coding": {
"$ref": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/coding.schema.json"
},
"event": {
"$ref": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/event.schema.json"
}
},
"required": [
"coding",
"event"
]
}
{
"event": {
"start_date": "2024-12-10",
"end_date": "2024-12-20"
},
"coding": {
"code": "MISSING_INFORMATION",
"code_set": [
"MISSING_INFORMATION"
],
"code_system": "https://bcgov.github.io/nr-pies/docs/spec/code_system/on_hold_process"
}
}
Implementation Notes
The Coding Event type is designed to act as a container data type representing a cartesian product between the Coding and Event data types. Both data types are required in order to have a semantically coherent Coding Event. Recipient systems will be able to associate a specific coding happening at a defined time using this data type.