Provenance - FHIR Resource (r4)


This Provenance Resource uses the FHIR API standard for access and structure.

Validate an Provenance FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
activityfalseCodeableConcept# Activity that occurred
agenttrueData Type# Actor involved
entitytrueData Type# An entity used in this activity
locationfalseReference# Where the activity occurred, if relevant
occurred[x]falsePeriod|dateTime#undefined
policytrueuri# Policy or plan the activity was defined by
reasontrueCodeableConcept# Reason the activity is occurring
recordedfalseinstant# When the activity was recorded / updated
signaturetrueSignature# Signature on target
targettrueReference# Target Reference(s) (usually version specific)

Provenance Example

{
  "resourceType": "Provenance",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">procedure record authored on 27-June 2015 by Harold Hippocrates, MD Content extracted from XDS managed CDA Referral received 26-June as authorized by a referenced Consent.</div>"
  },
  "target": [
    {
      "reference": "Procedure/example/_history/1"
    }
  ],
  "occurredPeriod": {
    "start": "2015-06-27",
    "end": "2015-06-28"
  },
  "recorded": "2015-06-27T08:39:24+10:00",
  "policy": [
    "http://acme.com/fhir/Consent/25"
  ],
  "location": {
    "reference": "Location/1"
  },
  "reason": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "3457005",
          "display": "Referral"
        }
      ]
    }
  ],
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code": "AUT"
          }
        ]
      },
      "who": {
        "reference": "Practitioner/xcda-author"
      }
    },
    {
      "id": "a1",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code": "DEV"
          }
        ]
      },
      "who": {
        "reference": "Device/software"
      }
    }
  ],
  "entity": [
    {
      "role": "source",
      "what": {
        "reference": "DocumentReference/example",
        "display": "CDA Document in XDS repository"
      }
    }
  ]
}

Provenance Structure

{
  "resourceType" : "Provenance",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "target" : [{ Reference(Any) }], // R!  Target Reference(s) (usually version specific)
  // occurred[x]: When the activity occurred. One of these 2:
  "occurredPeriod" : { Period },
  "occurredDateTime" : "<dateTime>",
  "recorded" : "<instant>", // R!  When the activity was recorded / updated
  "policy" : ["<uri>"], // Policy or plan the activity was defined by
  "location" : { Reference(Location) }, // Where the activity occurred, if relevant
  "reason" : [{ CodeableConcept }], // Reason the activity is occurring
  "activity" : { CodeableConcept }, // Activity that occurred
  "agent" : [{ // R!  Actor involved
    "type" : { CodeableConcept }, // How the agent participated
    "role" : [{ CodeableConcept }], // What the agents role was
    "who" : { Reference(Practitioner|PractitionerRole|RelatedPerson|Patient|
    Device|Organization) }, // R!  Who participated
    "onBehalfOf" : { Reference(Practitioner|PractitionerRole|RelatedPerson|
    Patient|Device|Organization) } // Who the agent is representing
  }],
  "entity" : [{ // An entity used in this activity
    "role" : "<code>", // R!  derivation | revision | quotation | source | removal
    "what" : { Reference(Any) }, // R!  Identity of entity
    "agent" : [{ Content as for Provenance.agent }] // Entity is attributed to this agent
  }],
  "signature" : [{ Signature }] // Signature on target
}

Provenance Search Parameters

The following search parameters can be used to query Provenance resources. Just submit them like so:

https://api.1up.health/fhir/r4/Provenance?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
agentreferenceagent.who
agent-roletextagent.role
agent-typetextagent.type
entityreferenceentity.what
locationreferencelocation
patientreferencetarget.where
recordeddaterecorded
signature-typetextsignature.type
targetreferencetarget
whendateoccurred