Attachment Reference Exchange (ARex)
0.1.0 - ci-build United States of America flag

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

Resource Profile: ARex Provenance ( Experimental )

Official URL: https://fhir.onyxhealth.io/us/arex/StructureDefinition/arex-provenance Version: 0.1.0
Draft as of 2026-08-12 Computable Name: ARexProvenance

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(ARex Manifest) Target Reference(s) (usually version specific)
... agent S 1..* BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
.... who SΣ 1..1 Reference(Organization) Publishing organization
... signature S 1..* Signature Signature on target
.... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant When the signature was created
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/jose
.... data S 1..1 base64Binary Detached JWS over the canonical serialization of the manifest

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.agent.type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.signature.​type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.
Provenance.signature.​sigFormat Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target S 1..1 Reference(ARex Manifest) Target Reference(s) (usually version specific)
... recorded S 1..1 instant When the activity was recorded / updated
... agent S 1..* BackboneElement Actor involved
.... type S 1..1 CodeableConcept How the agent participated
.... who S 1..1 Reference(Organization) Publishing organization
.... type S 1..1 Coding Indication of the reason the entity signed the object(s)
.... when S 1..1 instant When the signature was created
.... who S 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... sigFormat S 1..1 code The technical format of the signature
Fixed Value: application/jose
.... data S 1..1 base64Binary Detached JWS over the canonical serialization of the manifest

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(ARex Manifest) Target Reference(s) (usually version specific)
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.
... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
... agent S 1..* BackboneElement Actor involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
.... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
.... who SΣ 1..1 Reference(Organization) Publishing organization
.... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
.... what Σ 1..1 Reference(Resource) Identity of entity
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature S 1..* Signature Signature on target
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant When the signature was created
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/jose
.... data S 1..1 base64Binary Detached JWS over the canonical serialization of the manifest

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Provenance.reason Base extensible PurposeOfUse 📦3.1.0 THO v7.3
Provenance.activity Base extensible Provenance activity type 📍4.0.1 FHIR Std.
Provenance.agent.type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.
Provenance.signature.​type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.
Provenance.signature.​targetFormat Base required MimeType 📍4.0.1 FHIR Std.
Provenance.signature.​sigFormat Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Provenance

Summary

Mandatory: 4 elements
Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(ARex Manifest) Target Reference(s) (usually version specific)
... agent S 1..* BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
.... who SΣ 1..1 Reference(Organization) Publishing organization
... signature S 1..* Signature Signature on target
.... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant When the signature was created
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/jose
.... data S 1..1 base64Binary Detached JWS over the canonical serialization of the manifest

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.agent.type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.signature.​type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.
Provenance.signature.​sigFormat Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target S 1..1 Reference(ARex Manifest) Target Reference(s) (usually version specific)
... recorded S 1..1 instant When the activity was recorded / updated
... agent S 1..* BackboneElement Actor involved
.... type S 1..1 CodeableConcept How the agent participated
.... who S 1..1 Reference(Organization) Publishing organization
.... type S 1..1 Coding Indication of the reason the entity signed the object(s)
.... when S 1..1 instant When the signature was created
.... who S 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... sigFormat S 1..1 code The technical format of the signature
Fixed Value: application/jose
.... data S 1..1 base64Binary Detached JWS over the canonical serialization of the manifest

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(ARex Manifest) Target Reference(s) (usually version specific)
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.
... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
... agent S 1..* BackboneElement Actor involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
.... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
.... who SΣ 1..1 Reference(Organization) Publishing organization
.... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
.... what Σ 1..1 Reference(Resource) Identity of entity
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature S 1..* Signature Signature on target
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type SΣ 1..1 Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when SΣ 1..1 instant When the signature was created
.... who SΣ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... sigFormat S 1..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Fixed Value: application/jose
.... data S 1..1 base64Binary Detached JWS over the canonical serialization of the manifest

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Provenance.reason Base extensible PurposeOfUse 📦3.1.0 THO v7.3
Provenance.activity Base extensible Provenance activity type 📍4.0.1 FHIR Std.
Provenance.agent.type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 FHIR Std.
Provenance.signature.​type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.
Provenance.signature.​targetFormat Base required MimeType 📍4.0.1 FHIR Std.
Provenance.signature.​sigFormat Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Provenance

Summary

Mandatory: 4 elements
Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron