Provenance
Overview
The Provenance resource tracks the source of external information and is used to assess the trustworthiness and reliability of a resource. Sources can be an organization author or organization transmitter. The target
field references a resource that this Provenance entry is related to. Entities are Continuity of Care Documents (CCDs) generated through the DocumentReference resource.
This resource supports the following HL7® FHIR® US Core Implementation Guide STU 4.0.0 profiles:
The following fields are returned if valued:
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.
Terminology Bindings
Provenance.entity.role |
|
Search
Search for provenances that meet the supplied query parameters.
GET /Provenance?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
Conditionally | token |
The logical resource ID associated with the resource. It may be a list separated by commas. This parameter is required if the target parameter is not used. Example: _id=doc-1234
|
target |
Conditionally | reference |
The target references, which can be version-specific. See Notes for list of supported resources. Example: target=DocumentReference/66547
|
Notes
- When searching with the
_id
parameter:- Must not include any other parameters.
- When searching with the
target
parameter:- The following resources are supported at this time:
- AllergyIntolerance
- CarePlan
- CareTeam
- Condition
- DiagnosticReport
- DocumentReference
- Encounter
- Goal
- Immunization
- MedicationRequest
- Observation
- Patient
- Procedure
- The following resources are supported at this time:
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": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>DocumentReference/881049</li></ul><p><b>Recorded</b>: Oct 25, 2019 9:57 A.M. CDT</p><p><b>Agents</b>:</p><dl><dt>Baseline East Medical Center</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-202</p></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"
}
}
]
}
}
]
}
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"
}
}
]
}
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-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": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>DocumentReference/881049</li></ul><p><b>Recorded</b>: Oct 25, 2019 9:57 A.M. CDT</p><p><b>Agents</b>:</p><dl><dt>Baseline East Medical Center</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-202</p></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"
}
}
]
}
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"
}
}
]
}
}
]
}
Create
Create a new provenance.
POST /Provenance
Notes
- Only the body fields mentioned below are supported. Unsupported fields are ignored or can result in errors.
- The
Provenance.write
scope must be provided to create a provenance with an Observation Measurement Target.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
target
|
Yes |
Reference |
|
|
|||
recorded
|
Yes |
instant |
|
|
|||
agent
|
Yes |
BackboneElement |
|
|
|||
agent.type
|
No |
CodeableConcept |
|
|
|||
agent.role
|
No |
CodeableConcept |
|
|
|||
agent.who
|
Yes |
Reference |
|
|
|||
entity
|
No |
BackboneElement |
|
|
|||
entity.role
|
Yes |
code |
|
|
|||
entity.what
|
Yes |
Reference |
|
|
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 opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111 X-Request-Id: 11111111-1111-1111-1111-111111111111
The ETag
response header indicates the current If-Match
version to use on subsequent updates.