Tenant Id (platform infrastructure) Extension¶
| Canonical | http://services.well.com/fhir/auth/tenant-id |
|---|---|
| Status | draft · 1.26.0 |
| Base | Extension (constraint) |
| Context | DomainResource (element) |
| Source | FSH · JSON |
The platform tenant that owns this resource, stamped by the FHIR Gateway. PRIVATE INFRASTRUCTURE: it is not client-writable, the value is an opaque platform tenant id that resolves to nothing fetchable, and external consumers must not depend on it. Declared here because it appears on stored resources and is therefore part of what an implementer sees on the wire.
FSH
The authored source of truth: extensions/TenantIdExtension.fsh (edit on GitHub). One FSH file may define several related artifacts.
// TenantIdExtension.fsh
// The tenant stamp. Every resource stored through the FHIR Gateway carries this extension,
// and until now the IG did not declare it -- so implementers saw an undocumented extension on
// every payload, and there was nothing for a validator or a code generator to resolve.
//
// PLATFORM-OWNED, NOT CLIENT-WRITABLE. Tenancy follows the token: there is no operation that
// lets a client choose the tenant on a resource, and a tenant extension sent by a client is not
// honoured. What the gateway does with the value on each edge is platform behaviour, not a
// conformance rule of this specification, so it is not stated here.
//
// WHY THE CANONICAL IS OFF-HOST. Every other artifact in this IG is minted under
// `..`. This one is deliberately NOT: the URL below is the literal string
// the platform has always stamped and that stored data and a live search parameter already key
// on. Declaring the real URL is what makes the extension resolvable and honest. Moving it onto
// the governed host would be a data migration across every stored resource plus the search
// parameter, not a spec edit, so the IG documents what exists.
//
// EXTERNAL CONSUMERS: DO NOT DEPEND ON THIS. It is private infrastructure. The value is an
// opaque platform tenant id -- not a clinic identifier, not an Organization id, and not
// resolvable to anything you can fetch. Read it if you must correlate, never write it, never
// parse it, and expect it to change shape without a breaking-change note.
Extension: NexusTenantId
Id: nexus-tenant-id
Title: "Tenant Id (platform infrastructure)"
Description: "The platform tenant that owns this resource, stamped by the FHIR Gateway. PRIVATE INFRASTRUCTURE: it is not client-writable, the value is an opaque platform tenant id that resolves to nothing fetchable, and external consumers must not depend on it. Declared here because it appears on stored resources and is therefore part of what an implementer sees on the wire."
* ^url = "http://services.well.com/fhir/auth/tenant-id"
* ^status = #draft
* ^context[0].type = #element
* ^context[0].expression = "DomainResource"
* value[x] only string
* valueString 1..1
* valueString ^short = "Opaque platform tenant id -- do not parse, do not write"