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.
Elements / Details
Every element this profile touches, with its full definition. Element names in the tables link here.
Extension¶
| Short | Reporting Export Stamp Extension |
|---|---|
| Definition | 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.
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. |
| Cardinality | 0..* |
| Invariants | ele-1, ext-1 |
Extension.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 3..* |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:hic¶
| Short | The custodian the extract was stamped for (opaque) |
|---|---|
| Definition | The health information custodian the extract was produced for. An opaque token: do not parse it, and do not read it as an Organization identifier -- it names the custodian of the disclosure, not a resource in this store. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:hic.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:hic.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:hic.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | hic |
Extension.extension:hic.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | string |
| Invariants | ele-1 |
Extension.extension:purpose¶
| Short | The purpose declared for the disclosure |
|---|---|
| Definition | The purpose declared for the disclosure, as a coded concept.
Bound to HL7's PurposeOfUse, which is the published vocabulary for this fact: quality improvement
and research both have codes there already. The binding is extensible because the closed set an
extract is declared under is a property of the disclosure rather than of this specification, and
pinning that list here would freeze a snapshot of it. A purpose that PurposeOfUse has no code for carries an
additional local coding, or text alone.
An extract with no declared purpose is refused rather than exported, which is why this element is
required. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:purpose.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:purpose.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:purpose.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | purpose |
Extension.extension:purpose.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | v3-PurposeOfUse (extensible) |
| Invariants | ele-1 |
Extension.extension:asOf¶
| Short | The instant the run was anchored at |
|---|---|
| Definition | The instant the run was anchored at -- NOT the moment the file was produced. Two exports of one run at one anchor carry the same value, which is what makes them the same extract. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:asOf.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:asOf.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:asOf.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | asOf |
Extension.extension:asOf.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | instant |
| Invariants | ele-1 |
Extension.extension:watermarkPosition¶
| Short | The run's stored ingest position, verbatim (opaque) |
|---|---|
| Definition | The run's stored ingest position, carried verbatim. An opaque token whose form is not fixed by this specification; it is comparable only against another position from the same source, and carries no meaning on its own. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:watermarkPosition.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:watermarkPosition.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:watermarkPosition.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | watermarkPosition |
Extension.extension:watermarkPosition.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | string |
| Invariants | ele-1 |
Extension.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | ../StructureDefinition/reporting-export-stamp |
Extension.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..0 |
| Type | base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| Invariants | ele-1 |