Provenance

Overview

The Provenance resource tracks the source of data and is used to assess the trustworthiness and reliability of a resource. Soarian Clinicals® supports a read-only Application Programming Interface (API). This resource only accepts GET based read interaction.

The following fields are returned if valued:

Terminology Bindings

Provenance.agent.type
  • Description
    • The participation the agent had with respect to the activity.
  • Details: Provenance Participant Type
    System: https://terminology.hl7.org/CodeSystem/provenance-participant-type

Retrieve by ID

List an individual Provenance by its ID:

GET /Provenance/:id

Authorization Types

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Provenance/GO.A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083

Response

Status: 200 OK
{
  "resourceType": "Provenance",
  "id": "GO.A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
  "recorded": "2020-11-15T16:20:00-05:00",
  "target": [
    {
      "reference": "Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083"
    }
  ],
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
            "code": "author",
            "display": "Author"
          }
        ]
      },
      "who": {
        "reference": "Practitioner/40134EF110CA4C07988F544E90057844"
      },
      "onBehalfOf": {
        "reference": "Organization/HCU.1",
        "display": "Health Enterprise"
      }
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Provenance</b><br /><b>Target</b>:<b>Reference</b>:Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083 <br /><b>Recorded</b>:2020-11-15T16:20:00-05:00<br /><b>Agent:</b><br /><b>Type:</b><b>System</b>:http://terminology.hl7.org/CodeSystem/provenance-participant-type <b>Code</b>:author <b>Display</b>:Author<br /><b>Who</b>:<b>Reference</b>:Practitioner/40134EF110CA4C07988F544E90057844 <br /><b>OnBehalfOf</b>:<b>Reference</b>:Organization/HCU.1 <b>Display</b>:Health Enterprise</div>"
  }
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors