Provenance - FHIR Resource (dstu2)

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

Validate an Provenance FHIR Resource (dstu2)

Provenance Attributes

AttributeField is listTypeDescription

Description: Target Reference(s) (usually version specific)

FHIR Version: dstu2

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"target":

Learn more about the (Provenance) target FHIR attribute

Description: Activity that occurred

FHIR Version: dstu2

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"activity":

Learn more about the (Provenance) activity FHIR attribute

Description: When the activity was recorded / updated

FHIR Version: dstu2

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"recorded":

Learn more about the (Provenance) recorded FHIR attribute

Description: When the activity occurred

FHIR Version: dstu2

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"period":

Learn more about the (Provenance) period FHIR attribute

Description: Agents involved in creating resource

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"agent":

Learn more about the (Provenance) agent FHIR attribute

Description: An entity used in this activity

FHIR Version: dstu2

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"entity":

Learn more about the (Provenance) entity FHIR attribute

Description: Reason the activity is occurring

FHIR Version: dstu2

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reason":

Learn more about the (Provenance) reason FHIR attribute

Description: Where the activity occurred, if relevant

FHIR Version: dstu2

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"location":

Learn more about the (Provenance) location FHIR attribute

Description: Signature on target

FHIR Version: dstu2

Attribute Type : Signature

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"signature":

Learn more about the (Provenance) signature FHIR attribute

Description: Policy or plan the activity was defined by

FHIR Version: dstu2

Attribute Type : uri

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"policy":

Learn more about the (Provenance) policy FHIR attribute

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 them like so:

https://api.1up.health/fhir/dstu2/Provenance?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`agent`	`reference`	`agent.actor`
`end`	`date`	`period.end`
`entity`	`uri`	`entity.reference`
`entitytype`	`text`	`entity.type`
`location`	`reference`	`location`
`patient`	`reference`	`target`
`sigtype`	`text`	`signature.type`
`start`	`date`	`period.start`
`target`	`reference`	`target`
`userid`	`text`	`agent.userId`