Attachment Reference Exchange (ARex)
0.1.0 - ci-build
Attachment Reference Exchange (ARex)
0.1.0 - ci-build
Attachment Reference Exchange (ARex) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| ARex Content Consumer |
The party that retrieves a manifest and the content it references. |
| ARex Content Server |
The party that publishes a manifest and serves the content it references. In an escrow-hosted deployment this is an intermediary or neutral escrow; in a source-hosted deployment it is the originating organization. |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
| ARex Manifest Transaction Identifier |
Locate a manifest by a reassociation identifier from the governing transaction. This is the primary discovery path for a receiver that holds only a transaction identifier, such as an X12 278 TRN or a provider attachment control number. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| ARex Audit Event |
Record of a manifest publication, a manifest retrieval, or a content retrieval. Retained by the publisher so that the disclosing party can answer what was actually retrieved, by whom, and when. |
| ARex Binary |
A retrievable content object served as raw octets. Binary is used in preference to any base64-in-JSON representation: retrieval with a non-FHIR Accept header returns the native bytes and native content type, with no encoding inflation. NOTE: Binary is not a DomainResource and cannot carry extensions; all ARex metadata for an object lives on its ARex Content Entry. |
| ARex Content Entry |
Metadata for a single retrievable content object. One entry describes exactly one object; this granularity is what allows a receiver to plan transfers against its own size ceiling rather than requiring the sender to fragment. |
| ARex Manifest |
A signed, expiring index of content objects made available out-of-band from the transaction they support. The manifest is the unit of authorization, the unit of expiry, and the unit of revocation. |
| ARex Provenance |
Publisher attestation over a manifest. Carries the detached JWS that makes the manifest and its digests non-repudiable, which matters here in a way it does not for Bulk Data: this content is the evidentiary basis for a determination that may later be appealed. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| ARex Digest |
A cryptographic digest of the referenced content, computed over the octets as served. Defined as an extension on Attachment because Attachment.hash is defined as SHA-1 in FHIR R4 and is prohibited by this guide. |
| ARex Expires |
The instant after which the publisher no longer guarantees retrievability of the manifest or the content it references. This is a transfer-availability boundary only; it carries no record-retention meaning for either party. |
| ARex Requires Access Token |
Whether retrieval of the content referenced by this manifest requires an OAuth 2.0 access token. A value of false indicates capability-URL retrieval, which is a downgrade permitted only under an explicit trading partner agreement. |
| ARex Transaction Context |
The business context that binds a manifest to the transaction it supports. This element is simultaneously the reassociation key for the receiver and the authorization anchor for the content server: a token grant is scoped to these identifiers, not to a resource type. |
These define sets of codes used by systems conforming to this implementation guide.
| ARex Digest Algorithm Value Set |
Cryptographic digest algorithms permitted for ARex content integrity verification. |
| ARex Manifest Type Value Set |
Categories of content set conveyed by an ARex manifest. |
These define new code systems used by systems conforming to this implementation guide.
| ARex Digest Algorithm Code System |
Cryptographic digest algorithms permitted for ARex content integrity verification. SHA-1 is deliberately excluded. |
| ARex Manifest Type Code System |
Categories of content set conveyed by an ARex manifest. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| ARex Content Entry - Clinical Note |
A 4.1 MB scanned progress note. |
| ARex Content Entry - Imaging Report |
A 27 MB scanned imaging report. Its size is declared before retrieval so the receiver can plan the transfer rather than requiring the sender to fragment it. |
| ARex Example Patient |
Subject of the example manifest. |
| ARex Example Publishing Organization |
The organization that published the manifest. |
| ARex Example Requesting Organization |
The single organization entitled to retrieve the content. |
| ARex Manifest - Attachment Set |
A two-object attachment set, scoped to a single receiving organization and expiring 45 days after publication. |
| ARex Provenance - Manifest Attestation |
Publisher attestation over the example manifest. The signature data is illustrative and truncated. |