Provenance - FHIR Resource (stu3)


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

Validate an Provenance FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activityfalseCoding Activity that occurred
agenttrueData Type Actor involved
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
reasontrueCoding 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

{
  "target": [
    {
      "reference": "Procedure/example/_history/1"
    }
  ],
  "resourceType": "Provenance",
  "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</div>"
  },
  "recorded": "2015-06-27T08:39:24+10:00",
  "period": {
    "start": "2015-06-27",
    "end": "2015-06-28"
  },
  "agent": [
    {
      "relatedAgentType": {
        "text": "used"
      },
      "whoReference": {
        "reference": "Practitioner/xcda-author"
      },
      "role": [
        {
          "coding": [
            {
              "code": "AUT",
              "system": "http://hl7.org/fhir/v3/ParticipationType"
            }
          ]
        }
      ],
      "onBehalfOfUri": "#a1"
    },
    {
      "whoReference": {
        "reference": "Device/software"
      },
      "role": [
        {
          "coding": [
            {
              "code": "DEV",
              "system": "http://hl7.org/fhir/v3/ParticipationType"
            }
          ]
        }
      ],
      "id": "a1"
    }
  ],
  "entity": [
    {
      "whatReference": {
        "display": "CDA Document in XDS repository",
        "reference": "DocumentReference/example"
      },
      "role": "source"
    }
  ],
  "reason": [
    {
      "code": "3457005",
      "system": "http://snomed.info/sct",
      "display": "Referral"
    }
  ],
  "location": {
    "reference": "Location/1"
  },
  "policy": [
    "http://acme.com/fhir/Consent/25"
  ],
  "id": "example"
}

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
  "policy" : ["<uri>"], // Policy or plan the activity was defined by
  "location" : { Reference(Location) }, // Where the activity occurred, if relevant
  "reason" : [{ Coding }], // Reason the activity is occurring
  "activity" : { Coding }, // Activity that occurred
  "agent" : [{ // R!  Actor involved
    "role" : [{ CodeableConcept }], // What the agents role was
    // who[x]: Who participated. One of these 2:
    "whoUri" : "<uri>",
    "whoReference" : { Reference(Practitioner|RelatedPerson|Patient|Device|
    Organization) },
    // onBehalfOf[x]: Who the agent is representing. One of these 2:
    "onBehalfOfUri" : "<uri>",
    "onBehalfOfReference" : { Reference(Practitioner|RelatedPerson|Patient|Device|
    Organization) },
    "relatedAgentType" : { CodeableConcept } // Type of relationship between agents
  }],
  "entity" : [{ // An entity used in this activity
    "role" : "<code>", // R!  derivation | revision | quotation | source | removal
    // what[x]: Identity of entity. One of these 3:
    "whatUri" : "<uri>",
    "whatReference" : { Reference(Any) },
    "whatIdentifier" : { Identifier },
    "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/stu3/Provenance?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
agentreferenceagent.who
agent-roletextagent.role
enddateperiod.end
entity-idtextentity.what.as
entity-refreferenceentity.what.as
locationreferencelocation
patientreferencetarget
recordeddaterecorded
signature-typetextsignature.type
startdateperiod.start
targetreferencetarget