Provenance

Overview
Terminology Bindings
Search
Retrieve by id
Create

Overview

The Provenance resource tracks the source of external data and is used to assess the trustworthiness and reliability of a resource. Sources can be an organization author or organization transmitter. Entities are Continuity of Care DocumentReferences (CCDs).

The following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:

US Core Provenance Profile

The following fields are returned if valued:

Terminology Bindings

Provenance.entity.role

Description

How the entity was used during the activity.

Details: Provenance Entity Role
System: http://hl7.org/fhir/provenance-entity-role

Search

Search for Provenances that meet supplied query parameters:

GET /Provenance?:parameters

Authorization Types

Provider | Patient | System

Parameters

Name	Required?	Type	Description
`_id`	This or `target`	`token`	The logical resource id associated with the resource. Example: `doc-7845`
`target`	This or `_id`	`reference`	Target Reference(s) (usually version specific). The AllergyIntolerance, CarePlan, CareTeam, Condition, DiagnosticReport, DocumentReference, Encounter, Goal, Immunization, MedicationRequest, Observation, Patient and Procedure resources are supported. Example: `DocumentReference/66547`

Headers

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

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance?_id=doc-881057

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "160ad230-6a5c-4813-96e2-2b36be102145",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance?_id=doc-881057"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/doc-881057",
      "resource": {
        "resourceType": "Provenance",
        "id": "doc-881057",
        "meta": {
          "versionId": "881057",
          "lastUpdated": "2019-10-25T14:57:43Z"
        },
        "text": {
          "status": "generated",
          "div": "&lt;div xmlns="http://www.w3.org/1999/xhtml">&lt;p>&lt;b>Provenance&lt;/b>&lt;/p>&lt;p>&lt;b>Target&lt;/b>:&lt;/p>&lt;ul>&lt;li>DocumentReference/881049&lt;/li>&lt;/ul>&lt;p>&lt;b>Recorded&lt;/b>: Oct 25, 2019  9:57 A.M. CDT&lt;/p>&lt;p>&lt;b>Agents&lt;/b>:&lt;/p>&lt;dl>&lt;dt>Baseline East Medical Center&lt;/dt>&lt;dd>&lt;b>Agent Type&lt;/b>: Author&lt;/dd>&lt;dd>&lt;b>Agent Role&lt;/b>: Source&lt;/dd>&lt;/dl>&lt;p>&lt;b>Entity Source&lt;/b>: DocumentReference/S-202&lt;/p>&lt;/div>"
        },
        "target": [
          {
            "reference": "DocumentReference/881049"
          }
        ],
        "recorded": "2019-10-25T14:57:43Z",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Organization/619848",
              "display": "Baseline East Medical Center"
            }
          }
        ],
        "entity": [
          {
            "role": "source",
            "what": {
              "reference": "DocumentReference/S-202"
            }
          }
        ]
      }
    }
  ]
}

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.

Patient Authorization Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance?_id=all-1595070

Response

Status: 200 OK

{
  "resourceType": "Provenance",
  "id": "all-1595070",
  "meta": {
    "versionId": "1595070",
    "lastUpdated": "2019-12-09T16:49:43Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>AllergyIntolerance/S-1595069</li></ul><p><b>Recorded</b>: Dec  9, 2019 10:49 A.M. CST</p><p><b>Agents</b>:</p><dl><dt>Unknown</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-200</p></div>"
  },
  "target": [
    {
      "reference": "AllergyIntolerance/S-1595069"
    }
  ],
  "recorded": "2019-12-09T16: 49: 43Z",
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http: //terminology.hl7.org/CodeSystem/provenance-participant-type",
            "code": "author"
          }
        ],
        "text": "Author"
      },
      "role": [
        {
          "coding": [
            {
              "system": "http: //terminology.hl7.org/CodeSystem/contractsignertypecodes",
              "code": "SOURCE"
            }
          ],
          "text": "Source"
        }
      ],
      "who": {
        "reference": "Organization/50",
        "display": "Unknown"
      }
    }
  ],
  "entity": [
    {
      "role": "source",
      "what": {
        "reference": "DocumentReference/S-200"
      }
    }
  ]
}

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

The common errors and OperationOutcomes may be returned.

Retrieve by id

List an individual Provenance by its id:

GET /Provenance/:id

Authorization Types

Provider | Patient | System

Headers

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

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/doc-881057

Response

Status: 200 OK

{
  "resourceType": "Provenance",
  "id": "doc-881057",
  "meta": {
    "versionId": "881057",
    "lastUpdated": "2019-10-25T14:57:43Z"
  },
  "text": {
    "status": "generated",
    "div": "&lt;div xmlns="http://www.w3.org/1999/xhtml">&lt;p>&lt;b>Provenance&lt;/b>&lt;/p>&lt;p>&lt;b>Target&lt;/b>:&lt;/p>&lt;ul>&lt;li>DocumentReference/881049&lt;/li>&lt;/ul>&lt;p>&lt;b>Recorded&lt;/b>: Oct 25, 2019  9:57 A.M. CDT&lt;/p>&lt;p>&lt;b>Agents&lt;/b>:&lt;/p>&lt;dl>&lt;dt>Baseline East Medical Center&lt;/dt>&lt;dd>&lt;b>Agent Type&lt;/b>: Author&lt;/dd>&lt;dd>&lt;b>Agent Role&lt;/b>: Source&lt;/dd>&lt;/dl>&lt;p>&lt;b>Entity Source&lt;/b>: DocumentReference/S-202&lt;/p>&lt;/div>"
  },
  "target": [
    {
      "reference": "DocumentReference/881049"
    }
  ],
  "recorded": "2019-10-25T14:57:43Z",
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
            "code": "author"
          }
        ],
        "text": "Author"
      },
      "role": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
              "code": "SOURCE"
            }
          ],
          "text": "Source"
        }
      ],
      "who": {
        "reference": "Organization/619848",
        "display": "Baseline East Medical Center"
      }
    }
  ],
  "entity": [
    {
      "role": "source",
      "what": {
        "reference": "DocumentReference/S-202"
      }
    }
  ]
}

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.

Patient Authorization Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/all-1595070

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "3ddac8f3-0c3a-41fd-bd0a-1daeb6a42db9",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance?_id=all-1595070"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/all-1595070",
      "resource": {
        "resourceType": "Provenance",
        "id": "all-1595070",
        "meta": {
          "versionId": "1595070",
          "lastUpdated": "2019-12-09T16:49:43Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>AllergyIntolerance/S-1595069</li></ul><p><b>Recorded</b>: Dec  9, 2019 10:49 A.M. CST</p><p><b>Agents</b>:</p><dl><dt>Unknown</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-200</p></div>"
        },
        "target": [
          {
            "reference": "AllergyIntolerance/S-1595069"
          }
        ],
        "recorded": "2019-12-09T16: 49: 43Z",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http: //terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http: //terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Organization/50",
              "display": "Unknown"
            }
          }
        ],
        "entity": [
          {
            "role": "source",
            "what": {
              "reference": "DocumentReference/S-200"
            }
          }
        ]
      }
    }
  ]
}

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

The common errors and OperationOutcomes may be returned.

Create

Create a new Provenance.

POST /Provenance

Implementation Notes

Only the body fields mentioned below are supported. Unsupported fields will be ignored.
Modifier fields should not be provided, and will cause the transaction to fail.
The Provenance.write scopes must be provided in order to create a Provenance with an Observation Measurement target.

Authorization Types

Provider | System

Headers

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

Body Fields

Name	Required	Type
`resourceType`	Yes	`string`
Description The type of the FHIR resource. Example { "resourceType": "Provenance" } Notes resourceType must be Provenance. top of section
`target`	Yes	`Reference`
Description The Reference(s) that were generated or updated by the activity described in this resource. Example { "target": [ { "reference": "DocumentReference/881049" } ] } Notes Only one target may be provided. The AllergyIntolerance, Condition, DocumentReference, Encounter, Immunization, MedicationRequest, Observation, Patient and Procedure resources are supported. top of section
`recorded`	Yes	`instant`
Description The instant of time at which the activity was recorded. Example { "recorded": "2019-10-25T14:57:43Z" } top of section
`agent`	Yes	`BackboneElement`
Description An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. Example { "agent": [ { "type": { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type", "code": "transmitter" } ] }, "role": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes", "code": "SOURCE" } ] } ], "who": { "reference": "Organization/619848" } } ] } Notes Only one agent may be provided. top of section
`agent.type`	No	`CodeableConcept`
Description The participation the agent had with respect to the activity. Example { "type": { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type", "code": "transmitter" } ] } } top of section
`agent.role`	No	`CodeableConcept`
Description The function of the agent with respect to the activity. Example { "role": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes", "code": "SOURCE" } ] } ] } top of section
`agent.who`	Yes	`Reference`
Description The individual, device or organization that participated in the event. Example { "who": { "reference": "Organization/619848" } } top of section
`entity`	No	`BackboneElement`
Description An entity used in this activity. Example { "entity": [ { "role": "source", "what": { "reference": "DocumentReference/S-201" } } ] } top of section
`entity.role`	Yes	`code`
Description How the entity was used during the activity. Example { "role": "source" } top of section
`entity.what`	Yes	`Reference`
Description Identity of the Entity used. Example { "what": { "reference": "DocumentReference/S-201" } } top of section

Example

Request

POST https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance

Body

{
  "resourceType": "Provenance",
  "target": [
    {
      "reference": "DocumentReference/881049"
    }
  ],
  "recorded": "2019-10-25T14:57:43Z",
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
            "code": "transmitter"
          }
        ]
      },
      "role": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
              "code": "SOURCE"
            }
          ]
        }
      ],
      "who": {
        "reference": "Organization/619848"
      }
    }
  ],
  "entity": [
    {
      "role": "source",
      "what": {
        "reference": "DocumentReference/S-201"
      }
    }
  ]
}

Response

Status: 201 Created

Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Tue, 31 Mar 2020 15:37:25 GMT
Etag: W/"881057"
Location: https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/doc-881057
Last-Modified: Tue, 31 Mar 2020 15:37:25 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on subsequent updates.

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

The common errors and OperationOutcomes may be returned.

Millennium

Provenance

Overview

Terminology Bindings

Search

Authorization Types

Parameters

Headers

Example

Request

Response

Patient Authorization Request

Response

Errors

Retrieve by id

Authorization Types

Headers

Example

Request

Response

Patient Authorization Request

Response

Errors

Create

Authorization Types

Headers

Body Fields

Example

Request

Body

Response

Errors

R4 Overview

Foundation

Base

Clinical

Financial

Specialized

Bulk Data