Reporting Export Stamp Extension¶
| Canonical | ../StructureDefinition/reporting-export-stamp |
|---|---|
| Status | draft (experimental) · 1.26.0 |
| Base | Extension (constraint) |
| Context | Bundle.meta (element) |
| Source | FSH · JSON |
The disclosure stamp an identified reporting extract carries: which custodian the file was produced for, under what declared purpose, as of what instant, and from which stored ingest position. An extract is a FHIR collection Bundle of patient stubs handed to a requester as a file rather than stored on a server, and the stamp is how the file can still be answered for once it has left.
Overview
It rides Bundle.meta, because a Bundle has no extension of its own. Bundle is not a
DomainResource, so meta is the only place on it an extension can be carried. No search is given
up by that: an extract is a file, and nothing searches it.
The values are elements, with datatypes. asOf is an instant and purpose is a
CodeableConcept, so a consumer reads a point in time and a code rather than text it has to
interpret. Coding.display is defined by R4 as a representation of the meaning of a code, fixed by
the system that declares that code, so it is not somewhere a value can be carried -- an element with
a value[x] is.
The run is not here. It is Bundle.identifier, under the reporting-run naming system, and that
is where a consumer reads it from. One fact, one home.
hic and watermarkPosition are opaque. Neither has a form this specification fixes. Carry
them, correlate them, and do not parse them; an ingest position is comparable only against another
position from the same source.
Nothing clinical carries this. It describes an artefact's provenance, so it appears on the Bundle of an extract and nowhere on a patient's chart.
MIGRATION. Write this extension. The same fields were previously named as the codes of a code
system, for a key/value carriage on Bundle.meta.tag; that code system is retired in favour of this
extension. Stamps already written in the earlier carriage are not part of this specification, are
not produced going forward, and moving them is outstanding work that is not described here.
Terminology bindings
| Path | Strength | Value set |
|---|---|---|
Extension.extension.value[x] |
extensible | v3-PurposeOfUse |