DAF Research Implementation Guide v2.0.0 (STU2)
Formats: Narrative, XML, JSON, Turtle
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="daf-provenance"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-daf-provenance-definitions.html#Provenance:dafprovenance" title="Slice DAFProvenance: ">Provenance</a><a name="Provenance"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-daf-provenance-definitions.html#Provenance:dafprovenance.target">target</a><a name="Provenance.target"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/references.html">Reference</a>(<a style="opacity: 0.4" href="http://hl7.org/fhir/resource.html">Resource</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-daf-provenance-definitions.html#Provenance:dafprovenance.recorded">recorded</a><a name="Provenance.recorded"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#instant">instant</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-daf-provenance-definitions.html#Provenance:dafprovenance.agent">agent</a><a name="Provenance.agent"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#BackboneElement">BackboneElement</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-daf-provenance-definitions.html#Provenance:dafprovenance.agent.role">role</a><a name="Provenance.agent.role"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-daf-provenance-definitions.html#Provenance:dafprovenance.agent.who[x]">who[x]</a><a name="Provenance.agent.who_x_"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#uri">uri</a><span style="opacity: 0.4">, </span><a href="http://hl7.org/fhir/references.html">Reference</a>(<a style="opacity: 0.4" href="http://hl7.org/fhir/practitioner.html">Practitioner</a>)<span style="opacity: 0.4">, </span><a href="http://hl7.org/fhir/references.html">Reference</a>(<a style="opacity: 0.4" href="http://hl7.org/fhir/relatedperson.html">RelatedPerson</a>)<span style="opacity: 0.4">, </span><a href="http://hl7.org/fhir/references.html">Reference</a>(<a style="opacity: 0.4" href="http://hl7.org/fhir/patient.html">Patient</a>)<span style="opacity: 0.4">, </span><a href="http://hl7.org/fhir/references.html">Reference</a>(<a style="opacity: 0.4" href="http://hl7.org/fhir/device.html">Device</a>)<span style="opacity: 0.4">, </span><a href="http://hl7.org/fhir/references.html">Reference</a>(<a style="opacity: 0.4" href="http://hl7.org/fhir/organization.html">Organization</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-provenance"/> <version value="1.0.0"/> <name value="U.S. Data Access Framework (DAF) Provenance"/> <status value="draft"/> <date value="2014-08-21"/> <publisher value="Health Level Seven International (Infrastructure and Messaging - Data Access Framework)"/> <contact> <telecom> <system value="url"/> <value value="http://www.healthit.gov"/> </telecom> </contact> <fhirVersion value="3.0.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w3c.prov"/> <uri value="http://www.w3.org/ns/prov"/> <name value="W3C PROV"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <mapping> <identity value="fhirauditevent"/> <uri value="http://hl7.org/fhir/auditevent"/> <name value="FHIR AuditEvent"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Provenance"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Provenance"/> <derivation value="constraint"/> <snapshot> <element id="Provenance:dafprovenance"> <path value="Provenance"/> <sliceName value="DAFProvenance"/> <short value="Who, What, When for a set of resources"/> <definition value="Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies."/> <comment value="Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance."/> <alias value="History"/> <alias value="Event"/> <alias value="Activity"/> <min value="0"/> <max value="*"/> <base> <path value="Provenance"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <mustSupport value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="rim"/> <map value="ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity"/> </mapping> <mapping> <identity value="w5"/> <map value="infrastructure.information"/> </mapping> </element> <element id="Provenance:dafprovenance.id"> <path value="Provenance.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="Provenance:dafprovenance.meta"> <path value="Provenance.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="Provenance:dafprovenance.implicitRules"> <path value="Provenance.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="Provenance:dafprovenance.language"> <path value="Provenance.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="Provenance:dafprovenance.text"> <path value="Provenance.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Provenance:dafprovenance.contained"> <path value="Provenance.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance:dafprovenance.extension"> <path value="Provenance.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance:dafprovenance.modifierExtension"> <path value="Provenance.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance:dafprovenance.target"> <path value="Provenance.target"/> <short value="Target Reference(s) (usually version specific)"/> <definition value="The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity."/> <comment value="Target references are usually version specific, but may not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion."/> <min value="1"/> <max value="*"/> <base> <path value="Provenance.target"/> <min value="1"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.entity.reference"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity Created/Updated"/> </mapping> <mapping> <identity value="w5"/> <map value="what"/> </mapping> </element> <element id="Provenance:dafprovenance.period"> <path value="Provenance.period"/> <short value="When the activity occurred"/> <definition value="The period during which the activity occurred."/> <comment value="The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <mapping> <identity value="rim"/> <map value="./effectiveTime[type=IVL_TS]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.startTime & Activity.endTime"/> </mapping> <mapping> <identity value="w5"/> <map value="when.done"/> </mapping> </element> <element id="Provenance:dafprovenance.recorded"> <path value="Provenance.recorded"/> <short value="When the activity was recorded / updated"/> <definition value="The instant of time at which the activity was recorded."/> <comment value="This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.recorded"/> <min value="1"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.recorded"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.when"/> </mapping> <mapping> <identity value="w5"/> <map value="when.recorded"/> </mapping> </element> <element id="Provenance:dafprovenance.policy"> <path value="Provenance.policy"/> <short value="Policy or plan the activity was defined by"/> <definition value="Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc."/> <comment value="For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.policy"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <mapping> <identity value="rim"/> <map value="./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent.policy"/> </mapping> </element> <element id="Provenance:dafprovenance.location"> <path value="Provenance.location"/> <short value="Where the activity occurred, if relevant"/> <definition value="Where the activity occurred, if relevant."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.location"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <mapping> <identity value="rim"/> <map value="unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode="INST"]"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent.location"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.location"/> </mapping> <mapping> <identity value="w5"/> <map value="where"/> </mapping> </element> <element id="Provenance:dafprovenance.reason"> <path value="Provenance.reason"/> <short value="Reason the activity is occurring"/> <definition value="The reason that the activity was taking place."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.reason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceReason"/> </extension> <strength value="extensible"/> <description value="The reason the activity took place."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="unique(./reasonCode)"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.purposeOfEvent"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.Activity"/> </mapping> <mapping> <identity value="w5"/> <map value="why"/> </mapping> </element> <element id="Provenance:dafprovenance.activity"> <path value="Provenance.activity"/> <short value="Activity that occurred"/> <definition value="An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.activity"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceActivity"/> </extension> <strength value="extensible"/> <description value="The activity that took place."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/provenance-activity-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="Act.code"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.purposeOfEvent"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.Activity"/> </mapping> <mapping> <identity value="w5"/> <map value="why"/> </mapping> </element> <element id="Provenance:dafprovenance.agent"> <path value="Provenance.agent"/> <short value="Actor involved"/> <definition value="An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place."/> <comment value="Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa."/> <requirements value="An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility."/> <min value="1"/> <max value="*"/> <base> <path value="Provenance.agent"/> <min value="1"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <mapping> <identity value="rim"/> <map value="./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent"/> </mapping> <mapping> <identity value="w5"/> <map value="who"/> </mapping> </element> <element id="Provenance:dafprovenance.agent.id"> <path value="Provenance.agent.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance:dafprovenance.agent.extension"> <path value="Provenance.agent.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance:dafprovenance.agent.modifierExtension"> <path value="Provenance.agent.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance:dafprovenance.agent.role"> <path value="Provenance.agent.role"/> <short value="What the agents role was"/> <definition value="The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity."/> <comment value="For example: author, performer, enterer, attester, doctor, nurse, clerk, etc."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.agent.role"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceAgentRole"/> </extension> <strength value="extensible"/> <description value="The role that a provenance agent played with respect to the activity."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/security-role-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".role and/or .typecode"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent.role"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Attribution"/> </mapping> </element> <element id="Provenance:dafprovenance.agent.who[x]"> <path value="Provenance.agent.who[x]"/> <short value="Who participated"/> <definition value="The individual, device or organization that participated in the event."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.agent.who[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="w5"/> <map value="who.actor"/> </mapping> </element> <element id="Provenance:dafprovenance.agent.onBehalfOf[x]"> <path value="Provenance.agent.onBehalfOf[x]"/> <short value="Who the agent is representing"/> <definition value="The individual, device, or organization for whom the change was made."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.agent.onBehalfOf[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <mapping> <identity value="rim"/> <map value="Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]"/> </mapping> </element> <element id="Provenance:dafprovenance.agent.relatedAgentType"> <path value="Provenance.agent.relatedAgentType"/> <short value="Type of relationship between agents"/> <definition value="The type of relationship between agents."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.agent.relatedAgentType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RelatedAgentType"/> </extension> <strength value="example"/> <description value="Type of relationship between two provenance agents."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-RoleLinkType"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".typeCode"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="type"/> </mapping> </element> <element id="Provenance:dafprovenance.entity"> <path value="Provenance.entity"/> <short value="An entity used in this activity"/> <definition value="An entity used in this activity."/> <comment value="Multiple userIds may be associated with the same Practitioner or other individual across various appearances, each with distinct privileges."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.entity"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mapping> <identity value="rim"/> <map value="./subjectOf"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.entity"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity"/> </mapping> </element> <element id="Provenance:dafprovenance.entity.id"> <path value="Provenance.entity.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance:dafprovenance.entity.extension"> <path value="Provenance.entity.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance:dafprovenance.entity.modifierExtension"> <path value="Provenance.entity.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance:dafprovenance.entity.role"> <path value="Provenance.entity.role"/> <short value="derivation | revision | quotation | source | removal"/> <definition value="How the entity was used during the activity."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.entity.role"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceEntityRole"/> </extension> <strength value="required"/> <description value="How an entity was used in an activity."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/provenance-entity-role"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="./typeCode"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.entity.lifecycle"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.role"/> </mapping> </element> <element id="Provenance:dafprovenance.entity.what[x]"> <path value="Provenance.entity.what[x]"/> <short value="Identity of entity"/> <definition value="Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative."/> <comment value="Identity may be a reference to a resource or to something else, depending on the type."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.entity.what[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./text/reference"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.entity.reference"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.Identity"/> </mapping> </element> <element id="Provenance:dafprovenance.entity.agent"> <path value="Provenance.entity.agent"/> <short value="Entity is attributed to this agent"/> <definition value="The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity."/> <comment value="A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.entity.agent"/> <min value="0"/> <max value="*"/> </base> <contentReference value="#Provenance:dafprovenance.agent"/> <mapping> <identity value="rim"/> <map value="./author/role"/> </mapping> </element> <element id="Provenance:dafprovenance.signature"> <path value="Provenance.signature"/> <short value="Signature on target"/> <definition value="A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.signature"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Signature"/> </type> <mapping> <identity value="rim"/> <map value="./signatureText"/> </mapping> </element> </snapshot> <differential> <element id="Provenance:dafprovenance"> <path value="Provenance"/> <sliceName value="DAFProvenance"/> <mustSupport value="false"/> <isModifier value="false"/> </element> <element id="Provenance:dafprovenance.target"> <path value="Provenance.target"/> <min value="1"/> <max value="*"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="Provenance:dafprovenance.recorded"> <path value="Provenance.recorded"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="Provenance:dafprovenance.agent"> <path value="Provenance.agent"/> <min value="1"/> <max value="*"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="Provenance:dafprovenance.agent.role"> <path value="Provenance.agent.role"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="Provenance:dafprovenance.agent.who[x]"> <path value="Provenance.agent.who[x]"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> </differential> </StructureDefinition>
DAF Research v2.0.0 (STU2) © based on FHIR STU3 Version: 3.0.1 generated on Fri, Apr 21, 2017 08:00+1000. |
