Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Example Provenance/example (XML)

Security Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Device, Patient, Practitioner, RelatedPerson

Raw XML (canonical form + also see XML Format Specification)

Jump past Narrative

General Provenance Example - data extracted from CDA document from XDS (id = "example")

<?xml version="1.0" encoding="UTF-8"?>

<Provenance xmlns="http://hl7.org/fhir">
  <id value="example"/> 
<!--   
  <text>
    <status value="additional"/>
    <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>
  </text>
   -->
  <!--    
    where possible, provenance targets should be version specific,
    so that there is no ambiguity about which version of the 
    record this relates to
     -->
  <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: Provenance</b> <a name="example"> </a> </p> <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:
       1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Provenance &quot;example&quot; </p> </div> <p> <b> target</b> : <span title=" 
  &lt;text&gt;
    &lt;status value=&quot;additional&quot;/&gt;
    &lt;div xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;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.&lt;/div&gt;
  &lt;/text&gt;
 &amp;#10;  
    where possible, provenance targets should be version specific,
    so that there is no ambiguity about which version of the 
    record this relates to
   "><a href="procedure-example.html">Procedure/example/_history/1</a> </span> </p> <p> <b> occurred</b> : 2015-06-27 --&gt; 2015-06-28</p> <p> <b> recorded</b> : 27/06/2015 8:39:24 AM</p> <p> <b> policy</b> : <span title="  reference to a patient consent to share inforamtion  "><a href="http://acme.com/fhir/Consent/25">http://acme.com/fhir/Consent/25</a> </span> </p> <p> <b> location</b> : <a href="location-example.html">Location/1</a>  &quot;South Wing, second floor&quot;</p> <p> <b> activity</b> : Referral <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a> #3457005)</span> </p> <blockquote> <p> <b> agent</b> </p> <p> <b> type</b> : author (originator) <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-ParticipationType.html">ParticipationType</a> #AUT)</span> </p> <p> <b> who</b> : <a href="practitioner-example-xcda-author.html">Practitioner/xcda-author</a>  &quot;Harold HIPPOCRATES&quot;</p> </blockquote> <blockquote> <p> <b> agent</b> </p> <p> <b> type</b> : device <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-ParticipationType.html">ParticipationType</a> #DEV)</span> </p> <p> <b> who</b> : <span> : Device/software</span> </p> </blockquote> <h3> Entities</h3> <table class="grid"><tr> <td> -</td> <td> <b> Role</b> </td> <td> <b> What</b> </td> </tr> <tr> <td> *</td> <td> source</td> <td> <span title="  
      the document is in an XDS repository. 
      as a source, we're going to give an MHD 
      reference. (easier than XDS.b call with parameters!)
    Given the reference is to a FHIR DocumentReference, that resource describes
             the kind of content
     "><a href="documentreference-example.html">DocumentReference/example: CDA Document in XDS repository</a> </span> </td> </tr> </table> </div> </text> <target> 
    <reference value="Procedure/example/_history/1"/> 
  </target> 
  <occurredPeriod> 
    <start value="2015-06-27"/> 
    <end value="2015-06-28"/> 
  </occurredPeriod> 
  <recorded value="2015-06-27T08:39:24+10:00"/> 
  <!--    reference to a patient consent to share inforamtion    -->
  <policy value="http://acme.com/fhir/Consent/25"/> 
  <location> 
    <reference value="Location/1"/> 
  </location> 
  <activity> 
    <coding> 
      <system value="http://snomed.info/sct"/> 
      <code value="3457005"/> 
      <display value="Referral"/> 
    </coding> 
  </activity> 

  <!--    author = Harold Hippocrates    -->
  <agent> 
    <type> 
      <coding> 
        <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
        <code value="AUT"/> 
      </coding> 
    </type> 
    <who> 
      <reference value="Practitioner/xcda-author"/> 
    </who> 
    <!--    reference to other agent defined within    -->
    <!--      removed as unclear how to do this now     <onBehalfOf value="#a1"/>       -->
<!--   
    <onBehalfOf>
      <reference value="Practitioner/xcda-author"/>
    </onBehalfOf>>
     -->
  </agent> 
  <!--    device = software Harold used    -->
  <agent id="a1">
    <type> 
      <coding> 
        <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> 
        <code value="DEV"/> 
      </coding> 
    </type> 
    <who> 
      <display value="Device/software"/> 
    </who> 
  </agent> 
  <!--    information extract from a CCDA referral document    -->
  <entity> 
    <role value="source"/> 
    <!--    
      the document is in an XDS repository. 
      as a source, we're going to give an MHD 
      reference. (easier than XDS.b call with parameters!)
    Given the reference is to a FHIR DocumentReference, that resource describes
     the kind of content
       -->
    <what> 
      <reference value="DocumentReference/example"/>     
      <display value="CDA Document in XDS repository"/> 
    </what> 
  </entity> 
</Provenance> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.