Provenance - FHIR Resource (dstu2)


Resource Attributes

AttributeField is listTypeDescription
activityfalseCodeableConcept Activity that occurred
agenttrueData Type Agents involved in creating resource
entitytrueData Type An entity used in this activity
locationfalseReference Where the activity occurred, if relevant
periodfalsePeriod When the activity occurred
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 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)
  "period" : { Period }, // When the activity occurred
  "recorded" : "<instant>", // R!  When the activity was recorded / updated
  "reason" : [{ CodeableConcept }], // Reason the activity is occurring
  "activity" : { CodeableConcept }, // Activity that occurred
  "location" : { Reference(Location) }, // Where the activity occurred, if relevant
  "policy" : ["<uri>"], // Policy or plan the activity was defined by
  "agent" : [{ // Agents involved in creating resource
    "role" : { Coding }, // R!  What the agents involvement was
    "actor" : { Reference(Practitioner|RelatedPerson|Patient|Device|
    Organization) }, // Individual, device or organization playing role
    "userId" : { Identifier }, // Authorization-system identifier for the agent
    "relatedAgent" : [{ // Track delegation between agents
      "type" : { CodeableConcept }, // R!  Type of relationship between agents
      "target" : "<uri>" // R!  Reference to other agent in this resource by identifier
    }]
  }],
  "entity" : [{ // An entity used in this activity
    "role" : "<code>", // R!  derivation | revision | quotation | source
    "type" : { Coding }, // R!  The type of resource in this entity
    "reference" : "<uri>", // R!  Identity of entity
    "display" : "<string>", // Human description 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 the like so:

https://api.1up.health/fhir/dstu2/Provenance?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
agentreferenceagent.actor
enddateperiod.end
entityurientity.reference
entitytypetextentity.type
locationreferencelocation
patientreferencetarget
sigtypetextsignature.type
startdateperiod.start
targetreferencetarget
useridtextagent.userId