Resource Hidden Tag CodeSystem Code system¶
| Canonical | ../CodeSystem/resource-hidden |
|---|---|
| Status | draft · 1.26.0 |
| Content | complete |
| Source | FSH · JSON |
The visibility tag carried on Resource.meta.tag. A resource tagged true under this system is
withheld from ordinary search results.
The filter is applied by the server, not by the caller. Unless a search query names this system
itself, the Nexus EMR FHIR gateway appends a _tag:not term excluding true before the search
reaches the store. A client that does not know this tag exists still gets a filtered bundle, and
nothing in the response says so. Where completeness matters -- reconciliation, export, matching an
inbound record against what is already held -- name the system in the query rather than assuming an
unqualified search saw everything.
all is a query token and not a code in this system. A search naming <system>|all asks for
hidden and visible records together. It is never stored on a resource, so a reader matching stored
tags against it matches nothing.
Absent and false mean the same thing: visible. Both forms occur in stored data -- unhiding is
written in one place by removing the tag and in another by setting it to false -- and a reader
must treat them identically. Codes are written in lower case; compare case-insensitively, which is
what the readers in this estate do.
At most one tag under this system. Writers replace rather than append, and a reader should take the first and not attempt to reconcile two.
This is not a confidentiality label. It says a record is not wanted in search results, not that
it is sensitive and not that a caller is unauthorised to see it. Confidentiality belongs on
meta.security; authorization is decided by the scopes on the request. Nor is hiding a substitute
for entered-in-error or for deletion: a hidden record is a current record that a search does not
surface.
Content is complete for the tag vocabulary defined here (true, false).
MIGRATION. Nexus EMR writes this tag today under
http://services.well.com/fhir/tags/hidden (FHIR-381): that address is live in stored meta.tag
codings, in code, and in the server-side search filter that reads them, and is under migration to
the canonical declared here. Match both addresses exactly when reading stored tags. When QUERYING,
name the address the endpoint's own CapabilityStatement carries: this is the one artifact in this
position whose address a request has to name to change what comes back, so during the migration the
two are not interchangeable in a query the way they are in stored data.
| Code | Display | Definition |
|---|---|---|
true |
Hidden | The resource is withheld from ordinary search results. It still exists, is still readable by direct read, and is still resolvable as a reference target -- it is excluded from sear… |
false |
Visible | The resource is returned by ordinary search. Carries no information that an absent tag does not also carry; it exists so a writer can clear the flag in place rather than remove th… |