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.

read

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

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.

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.

    • type
      required, object

      The participation the agent had with respect to the activity.

      • coding
        required, Array of object
        • system
          required, string
          Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
        • code
          required, string
          Value: author
    • who
      required, object

      The individual, device or organization that participated in the event.

      Must reference one of the following types of resources:

      • Practitioner
      • PractitionerRole
      • RelatedPerson
      • Patient
      • Device
      • Organization
      • id
        string

        A sequence of Unicode characters

      • extension
        Array of object

        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.

        • id
          string

          A sequence of Unicode characters

        • url
          string

          String of characters used to identify a name or a resource

        • valueBase64Binary
          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • reference
        string

        A sequence of Unicode characters

      • _reference
        object

        Extensions for reference

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • type
        string

        String of characters used to identify a name or a resource

      • _type
        object

        Extensions for type

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • identifier
        object

        An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • use

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old
        • _use
          object

          Extensions for use

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • type
          object

          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • coding
            Array of object

            A reference to a code defined by a terminology system.

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • system
              string

              String of characters used to identify a name or a resource

            • _system
              object

              Extensions for system

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                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.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • version
              string

              A sequence of Unicode characters

            • _version
              object

              Extensions for version

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                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.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • code
              string

              A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

            • _code
              object

              Extensions for code

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                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.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • display
              string

              A sequence of Unicode characters

            • _display
              object

              Extensions for display

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                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.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            • userSelected
              boolean

              Value of "true" or "false"

            • _userSelected
              object

              Extensions for userSelected

              • id
                string

                A sequence of Unicode characters

              • extension
                Array of object

                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.

                • id
                  string

                  A sequence of Unicode characters

                • url
                  string

                  String of characters used to identify a name or a resource

                • valueBase64Binary
                  string

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • text
            string

            A sequence of Unicode characters

          • _text
            object

            Extensions for text

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • system
          string

          String of characters used to identify a name or a resource

        • _system
          object

          Extensions for system

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • value
          string

          A sequence of Unicode characters

        • _value
          object

          Extensions for value

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • period
          object

          Time period during which identifier is/was valid for use.

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • start
            string

            A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

          • _start
            object

            Extensions for start

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • end
            string

            A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

          • _end
            object

            Extensions for end

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • display
        string

        A sequence of Unicode characters

      • _display
        object

        Extensions for display

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).