Provenance read

get/Provenance/{id}

Page View

This resource contains authenticity information to verify the legitimacy of data provided in a related resource. The details may include when and who prepared the data for another resource. Typically, a Provenance resource is provided for audit, security, or transparency purposes.

You can only review provenance information.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific Provenance resource with authenticity details for a related resource.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Provenance/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
Provenance identifier

Response fields and example

Example payload generated from schema

1
{
2
  "resourceType": "Provenance",
3
  "target": [
4
    {
5
      "reference": "string"
6
    }
7
  ],
8
  "recorded": "string",
9
  "agent": [
10
    {
11
      "type": {
12
        "coding": [
13
          {
14
            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
15
            "code": "author"
16
          }
17
        ]
18
      },
19
      "who": null
20
    }
21
  ]
22
}

resourceType
required, string
Identifies the type of the resource
Value: Provenance
target
required, Array of object
The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

Must be a resource of type Resource.
- reference
  string
  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
recorded
required, string
The instant of time at which the activity was recorded.
agent
required, Array of ProvenanceAuthor, ProvenanceTransmitter or Other
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.