Document Reference Readonly Tag CodeSystem Code system¶
| Canonical | ../CodeSystem/document-reference-readonly |
|---|---|
| Status | draft · 1.26.0 |
| Content | complete |
| Source | FSH · JSON |
Marks a DocumentReference as system-provisioned: a record the software creates and maintains,
which a user interface must not offer to delete or rewrite. Carried as a tag on
DocumentReference.meta.tag, where this is the tag's system. Seeded form templates -- the
tenant-wide blanks a filled form is started from -- are the population that carries it today.
A tag, not an extension. The address identifies the system of a Coding in meta.tag, which
is why it is declared as a code system. The vocabulary is the unusual part: the codes are the
literal strings true and false.
Absent means not readonly, and only true is written. A missing tag, the code false, and any
unexpected value all mean the same thing to the readers in this estate, none of which raises an
error. false is declared because a reader has to handle it, not because a writer emits it. Codes
are written in lower case and compared case-insensitively.
It is provenance with a UI consequence, not an authorization. It says the system owns the record and will reassert it -- a deletion is undone at the next reconciliation and an edit is overwritten, which is why the actions are withheld rather than allowed to fail. It grants and withholds no access; that is decided by the scopes on the request. Nor does it say anything about the document's content, its status, or whether a form filled from it may be edited.
MIGRATION. Nexus EMR writes this tag today at
../tags/document-reference/readonly. That address is on this guide's own
base but not at a published artifact path -- artifacts here are published at
/[artifact-type]/[artifact-id], and tags is not an artifact type -- so it is a pre-migration
address like any other, and is live in stored meta.tag codings and in code on both the server and
the client. Write the canonical declared here; expect both until the migration completes, and match
both addresses exactly rather than deriving one from the other.
| Code | Display | Definition |
|---|---|---|
true |
Readonly | The document is system-provisioned. It is created and maintained by the software, is reasserted if removed or altered, and a user interface must not offer to delete it or rewrite … |
false |
Not readonly | The document is an ordinary chart record. Carries nothing an absent tag does not -- it exists so the flag can be cleared in place rather than by removing the coding, and a reader … |