Add treatment_transfer schema for entity transfer tracking#48
Merged
Conversation
Imported from NDI-matlab's v1
src/ndi/ndi_common/schema_documents/treatment/treatment_transfer_schema.json
with the universal V_alpha -> V_delta renames applied:
- Top-level: classname/superclasses promoted under document_class
with class_version 1.0.0, maturity_level stable, and the
V_delta {class_name} superclass-reference shape.
- depends_on: mustbenotempty (lowercase, 0/1) -> mustBeNonEmpty
(camelCase boolean); documentation strings filled; empty
must_refer_to_document_class to match the treatment/treatment_drug
pattern.
- fields: string -> char; queryable 0/1 -> boolean; v1 parameters
collapsed into V_delta constraints (min/max for timestamp,
maxLength for char fields); blank_value/default_value separated;
mustBeScalar/mustNotHaveNaN populated.
- snake_case rename: entity_ontologyNode -> entity_ontology_node,
method_ontologyNode -> method_ontology_node.
Sibling of treatment and treatment_drug in V_delta/stable. Registered
in V_delta/index.json. Preserves the v1 paired-fields shape (name +
ontology_node), matching what treatment.json currently ships rather
than the future ontology_term collapse described in
conversions/from_did_v1/treatment.md.
Closes the only blocking gap for NDI-matlab issue #774c (deprecate
the bundled schema_documents directory): the other two v1 NDI
schemas missing from V_delta (animalsubject, subjectmeasurement)
are being retired upstream.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a new
treatment_transferschema class to the V_delta stable tier, enabling documentation and tracking of entity transfers between subjects in experimental or clinical settings.Key Changes
New schema file:
schemas/V_delta/stable/treatment_transfer.jsontreatment_transfer(v1.0.0) that extends thebaseclassSchema structure:
recipient_id(non-empty) and optionaldonor_idto track transfer source and destinationtimestamp: Transfer occurrence time (supports both global and local clocks)clocktype: Clock type specification for the timestampentity_nameandentity_ontology_node: Paired fields to identify what was transferred (e.g., 'blood', 'medium') with ontology supportmethod_nameandmethod_ontology_node: Paired fields to describe the transfer method (e.g., 'blood transfusion', 'titanium pick') with ontology supportIndex update: Registered the new
treatment_transferclass inschemas/V_delta/index.jsonwith appropriate metadataNotable Details
recipient_idare optional, allowing flexible documentation of transfershttps://claude.ai/code/session_01DtHfxqZ6bqCSFoNFmS2h7E