Admin: Add Navbox platform (via update-page on MediaWiki MCP Server)

2026-07-06T04:23:24Z

Add Navbox platform (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 09:53, 6 July 2026
Line 209:		Line 209:
	* After creation, <code>associating_type</code>, <code>associating_id</code>, <code>object_type</code>, and <code>name</code> are fixed. Only <code>object_value</code> and <code>note</code> can change, via <code>MetaArtifactUpdateSpec</code>.		* After creation, <code>associating_type</code>, <code>associating_id</code>, <code>object_type</code>, and <code>name</code> are fixed. Only <code>object_value</code> and <code>note</code> can change, via <code>MetaArtifactUpdateSpec</code>.
	* <code>EMRBaseModel</code> maintains the audit fields (<code>created_by</code>, <code>updated_by</code>, <code>created_date</code>, <code>modified_date</code>), the public <code>external_id</code> (exposed as <code>id</code>), and soft-delete (<code>deleted</code>). Don't set them from clients.		* <code>EMRBaseModel</code> maintains the audit fields (<code>created_by</code>, <code>updated_by</code>, <code>created_date</code>, <code>modified_date</code>), the public <code>external_id</code> (exposed as <code>id</code>), and soft-delete (<code>deleted</code>). Don't set them from clients.

			{{Navbox platform}}

	{{Related}}		{{Related}}

Admin: OHC identity seed

2026-07-04T22:45:31Z

OHC identity seed

New page

{{Doc header
|type=reference
|domain=platform
|title=Meta Artifact
|order=2
|introduced=3.0
|model=MetaArtifact
|reference=References/Encounter
}}

A <code>MetaArtifact</code> attaches a freeform metadata payload to any Care object without a dedicated foreign key. You reach for it when a feature needs to hang structured data — a drawing on a patient, say — off an existing record without adding a column or a join table.

Storage and schema split across two layers. The Django model stays loose: <code>object_value</code> is an opaque <code>JSONField</code>, and <code>associating_type</code> / <code>object_type</code> are bare <code>CharField</code>s. The Pydantic resource specs constrain those values to known enums and define the request/response shapes the API accepts.

'''Source:'''

* Model: [<nowiki/>https://github.com/ohcnetwork/care/blob/develop/care/emr/models/meta_artifact.py <code>care/emr/models/meta_artifact.py</code>]
* Resource specs: [<nowiki/>https://github.com/ohcnetwork/care/blob/develop/care/emr/resources/meta_artifact/spec.py <code>care/emr/resources/meta_artifact/spec.py</code>]

== Models ==

{| class="wikitable"
|-
! Model
! Purpose
|-
| <code>MetaArtifact</code>
| Generic, polymorphic metadata record attached to any Care object by type + external ID
|}

<code>MetaArtifact</code> extends [[References/Base models & conventions|<code>EMRBaseModel</code>]], the shared Care EMR base that provides <code>external_id</code>, the audit fields <code>created_by</code> / <code>updated_by</code> and <code>created_date</code> / <code>modified_date</code>, and the soft-delete flag <code>deleted</code>.

== <code>MetaArtifact</code> fields ==

=== Association ===

There is no Django <code>ForeignKey</code> to a parent. A <code>MetaArtifact</code> points at its target by storing the target's type and <code>external_id</code> instead.

{| class="wikitable"
|-
! Field
! Type
! Notes
{{Field|model=MetaArtifact|section=Association|name=associating_type|type=CharField(255)|notes=Non-null. The kind of object this artifact hangs off. API-constrained to [[#metaartifactassociatingtypechoices-values}}
{{Field|model=MetaArtifact|section=Association|name=associating_external_id|type=UUIDField|notes=Non-null. The parent's <code>external_id</code>. Set server-side from the spec's <code>associating_id</code> (see [[#resource-specs-api-schema}}
|}

A composite database index covers these two fields (see [[#methods--save-behaviour|Methods & save behaviour]]), so looking up every artifact for a given parent stays cheap.

=== Content ===

{| class="wikitable"
|-
! Field
! Type
! Notes
{{Field|model=MetaArtifact|section=Content|name=name|type=CharField(255)|notes=Spec rejects blank/whitespace-only on create}}
{{Field|model=MetaArtifact|section=Content|name=object_type|type=CharField(255)|notes=Names the shape held in <code>object_value</code>. API-constrained to [[#metaartifactobjecttypechoices-values}}
{{Field|model=MetaArtifact|section=Content|name=object_value|type=JSONField|notes=The payload. Spec types it as <code>dict | list</code>, required with no default}}
{{Field|model=MetaArtifact|section=Content|name=note|type=TextField|notes=Nullable. Spec: <code>str | None</code>, default <code>None</code>}}
|}

== Enum values ==

Two <code>str</code> enums constrain <code>associating_type</code> and <code>object_type</code> at the API layer. Both live in <code>spec.py</code> — this resource has no separate <code>constants.py</code> or <code>valueset.py</code>.

=== <code>MetaArtifactAssociatingTypeChoices</code> values ===

Binds <code>associating_type</code>.

{| class="wikitable"
|-
! Value
|-
| <code>patient</code>
|-
| <code>encounter</code>
|}

=== <code>MetaArtifactObjectTypeChoices</code> values ===

Binds <code>object_type</code>.

{| class="wikitable"
|-
! Value
|-
| <code>drawing</code>
|}

== Resource specs (API schema) ==

All specs extend <code>EMRResource</code> ([<nowiki/>https://github.com/ohcnetwork/care/blob/develop/care/emr/resources/base.py <code>care/emr/resources/base.py</code>]), which provides <code>serialize</code> (model → pydantic) and <code>de_serialize</code> (pydantic → model) along with the <code>perform_extra_serialization</code> / <code>perform_extra_deserialization</code> hooks. <code>__model__ = MetaArtifact</code>.

{| class="wikitable"
|-
! Spec
! Role
! Fields exposed
|-
| <code>MetaArtifactBaseSpec</code>
| shared
| <code>id</code> (<code>UUID4 | None</code>), <code>object_value</code> (<code>dict | list</code>), <code>note</code> (<code>str | None</code>)
|-
| <code>MetaArtifactCreateSpec</code>
| write · create
| base + <code>associating_type</code>, <code>associating_id</code> (<code>UUID4</code>), <code>object_type</code>, <code>name</code>
|-
| <code>MetaArtifactUpdateSpec</code>
| write · update
| identical to <code>MetaArtifactBaseSpec</code> (only <code>object_value</code> / <code>note</code> are mutable; association and type are fixed after create)
|-
| <code>MetaArtifactReadSpec</code>
| read · detail/list
| base + <code>associating_type</code>, <code>associating_id</code>, <code>object_type</code>, <code>name</code>, <code>created_date</code>, <code>modified_date</code>, <code>created_by</code> (<code>dict | None</code>), <code>updated_by</code> (<code>dict | None</code>)
|}

Field-level details and validation:

{| class="wikitable"
|-
! Field
! Spec type
! Required
! Default
! Validation / behaviour
|-
| <code>id</code>
| <code>UUID4 | None</code>
| optional
| <code>None</code>
| Read-only; populated from <code>obj.external_id</code> in <code>perform_extra_serialization</code>
|-
| <code>object_value</code>
| <code>dict | list</code>
| yes
| —
| Arbitrary JSON object or array
|-
| <code>note</code>
| <code>str | None</code>
| no
| <code>None</code>
| Free text
|-
| <code>associating_type</code>
| <code>MetaArtifactAssociatingTypeChoices</code>
| yes (create)
| —
| <code>patient</code> or <code>encounter</code>
|-
| <code>associating_id</code>
| <code>UUID4</code>
| yes (create)
| —
| Parent's <code>external_id</code>; copied to model field <code>associating_external_id</code> in <code>perform_extra_deserialization</code>
|-
| <code>object_type</code>
| <code>MetaArtifactObjectTypeChoices</code>
| yes (create)
| —
| <code>drawing</code>
|-
| <code>name</code>
| <code>str</code>
| yes (create)
| —
| <code>validate_name</code> rejects blank/whitespace-only with <code>"Name cannot be empty"</code>
|-
| <code>created_date</code>
| <code>datetime</code>
| read
| —
| From <code>EMRBaseModel</code>
|-
| <code>modified_date</code>
| <code>datetime</code>
| read
| —
| From <code>EMRBaseModel</code>
|-
| <code>created_by</code> / <code>updated_by</code>
| <code>dict | None</code>
| read
| <code>None</code>
| Serialized via <code>serialize_audit_users</code> (cached <code>UserSpec</code>)
|}

Server-maintained behaviour:

* '''Create''' (<code>MetaArtifactCreateSpec.perform_extra_deserialization</code>): sets <code>obj.associating_external_id = self.associating_id</code>. Clients send the parent's <code>external_id</code> as <code>associating_id</code>; the model stores it under <code>associating_external_id</code>.
* '''Read''' (<code>MetaArtifactReadSpec.perform_extra_serialization</code>): sets <code>mapping["id"] = obj.external_id</code> and calls <code>serialize_audit_users</code> to attach <code>created_by</code> / <code>updated_by</code>.
* '''Update''': <code>MetaArtifactUpdateSpec</code> exposes only <code>object_value</code> and <code>note</code> (plus the inherited optional <code>id</code>). It never re-accepts <code>associating_type</code>, <code>associating_id</code>, <code>object_type</code>, or <code>name</code>, so association and classification are immutable once the record exists.

No field on this resource binds to a value set (there is no <code>valueset.py</code>); the only constrained vocabularies are the two <code>str</code> enums above.

== Methods & save behaviour ==

<code>MetaArtifact</code> adds no custom methods and overrides neither <code>save()</code> nor <code>delete()</code>. Audit and soft-delete behaviour come entirely from [[References/Base models & conventions|<code>EMRBaseModel</code>]].

Its <code>Meta</code> declares one composite index to back parent-object lookups:

<syntaxhighlight lang="text">Index(fields=["associating_type", "associating_external_id"])</syntaxhighlight>
== API integration notes ==

* Reference the target by its <code>external_id</code> (UUID), never its internal primary key, and pass it as <code>associating_id</code> on create. The <code>associating_type</code> + <code>associating_external_id</code> pair lets one table hold metadata for many Care object types without per-type foreign keys.
* Add a new association or artifact kind by extending the <code>str</code> enums in <code>spec.py</code> — no schema migration, since the underlying <code>CharField</code>s are already open.
* <code>object_value</code> accepts any <code>dict | list</code>, so payloads carry feature-specific structure without migrations; <code>object_type</code> records which shape to expect (e.g. <code>drawing</code>).
* After creation, <code>associating_type</code>, <code>associating_id</code>, <code>object_type</code>, and <code>name</code> are fixed. Only <code>object_value</code> and <code>note</code> can change, via <code>MetaArtifactUpdateSpec</code>.
* <code>EMRBaseModel</code> maintains the audit fields (<code>created_by</code>, <code>updated_by</code>, <code>created_date</code>, <code>modified_date</code>), the public <code>external_id</code> (exposed as <code>id</code>), and soft-delete (<code>deleted</code>). Don't set them from clients.

{{Related}}

References/Meta Artifact - Revision history

Admin: Add Navbox platform (via update-page on MediaWiki MCP Server)

Admin: OHC identity seed