Functional standard / Foundation
Versioning of care definitions
Long-term care outlives any one version of a protocol. This page says which version governs a patient who is already in care.
A published definition is frozen. A change is a new draft of the same key, with the next version. A new instance uses the latest published version, preferring a site's own over the shared library.
An instance records definition_id and definition_version when it is created. This applies when the definition is named by definition_key and when it is derived from cohort_key, protocol_key, or plugin_key.
| Behavior | Version used |
|---|---|
| Cohort entry and exit actions | The version the patient enrolled under, even if it has since been retired |
| Journey moves, requirements, gates, and effects | The version the journey started under |
| Protocol templates | The protocol version at assignment. Each template uses the latest published version of its own key at that moment. |
| New enrolments and assignments | The latest published version. A retired version is not offered. |
| Records created before pinning | No version was recorded, so the latest published version applies |