. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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
Profile for provenance
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="provenance-definitions.html#Provenance" title="Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance."><b>Provenance</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --> <<a class="dict" href="provenance-definitions.html#Provenance.target" title="The resource(s) that were generated 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."><b>target</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..*</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="resourcelist.html">Any</a>)</span> <span style="color: navy">Target resource(s) (usually version specific)</span><span style="color: Gray"> --></span></target> <<a class="dict" href="provenance-definitions.html#Provenance.period" title="The period during which the activity occurred."><b>period</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Period">Period</a></span> <span style="color: navy">When the activity occurred</span><span style="color: Gray"> --></span></period> <<a class="dict" href="provenance-definitions.html#Provenance.recorded" title="The instant of time at which the activity was recorded."><b>recorded</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#instant">instant</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">When the activity was recorded / updated</span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.reason" title="The reason that the activity was taking place."><b>reason</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy">Reason the activity is occurring</span><span style="color: Gray"> --></span></reason> <<a class="dict" href="provenance-definitions.html#Provenance.location" title="Where the activity occurred, if relevant."><b>location</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="location.html#Location">Location</a>)</span> <span style="color: navy">Where the activity occurred, if relevant</span><span style="color: Gray"> --></span></location> <<a class="dict" href="provenance-definitions.html#Provenance.policy" title="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."><b>policy</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: navy">Policy or plan the activity was defined by</span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.agent" title="An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility."><b>agent</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Person, organization, records, etc. involved in creating resource --></span> <<a class="dict" href="provenance-definitions.html#Provenance.agent.role" title="The role that the participant played."><b>role</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Coding">Coding</a></span> <span style="color: navy"><a href="valueset-provenance-agent-role.html" style="color: navy">e.g. author | overseer | enterer | attester | source | cc: +</a></span><span style="color: Gray"> --></span></role> <<a class="dict" href="provenance-definitions.html#Provenance.agent.type" title="The type of the participant."><b>type</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Coding">Coding</a></span> <span style="color: navy"><a href="valueset-provenance-agent-type.html" style="color: navy">e.g. Resource | Person | Application | Record | Document +</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="provenance-definitions.html#Provenance.agent.reference" title="Identity of participant. May be a logical or physical uri and maybe absolute or relative."><b>reference</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Identity of agent (urn or url)</span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.agent.display" title="Human-readable description of the participant."><b>display</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Human description of participant</span><span style="color: Gray"> --></span> </agent> <<a class="dict" href="provenance-definitions.html#Provenance.entity" title="An entity used in this activity."><b>entity</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> An entity used in this activity --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.role" title="How the entity was used during the activity."><b>role</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="provenance-entity-role.html" style="color: navy">derivation | revision | quotation | source</a></span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.type" title="The type of the entity. If the entity is a resource, then this is a resource type."><b>type</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Coding">Coding</a></span> <a href="resource-types.html" style="color: navy">Resource Type, or something else</a><span style="color: Gray"> --></span></type> <<a class="dict" href="provenance-definitions.html#Provenance.entity.reference" title="Identity of participant. May be a logical or physical uri and maybe absolute or relative."><b>reference</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Identity of participant (urn or url)</span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.display" title="Human-readable description of the entity."><b>display</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Human description of participant</span><span style="color: Gray"> --></span> <<a class="dict" href="provenance-definitions.html#Provenance.entity.agent" title="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."><b>agent</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen">Content as for Provenance.agent</span> <span style="color: navy">Entity is attributed to this agent</span><span style="color: Gray"> --></span></agent> </entity> <<a class="dict" href="provenance-definitions.html#Provenance.integritySignature" title="A digital signature on the target resource(s). The signature should match a Provenance.agent.referen ce in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation."><b>integritySignature</b></a> value="[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Base64 signature (DigSig) - integrity check</span><span style="color: Gray"> --></span> </Provenance> </pre></div> </text> <name value="provenance"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage The provenance resource tracks information about activity that created a version of a resource, including the entities, and agents involved in producing a resource. This information can be used to form assessments about its quality, reliability or trustworthiness, or to provide pointers for where to go to further investigate the origins of the resource and the information in it. Provenance resources are a record-keeping assertion that gathers information about the context in which the information in a resource was obtained. Provenance resources are prepared by the application that initiates the create/update etc. of the resource. A Security Event resource contains overlapping information, but is created as events occur, to track and audit the events. Security Event resources are often (though not exclusively) created by the application responding to the read/query/create/update etc. event."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="w3c.prov"/> <uri value="http://www.w3.org/ns/prov"/> <name value="W3C PROV"/> </mapping> <structure> <type value="Provenance"/> <publish value="true"/> <element> <path value="Provenance"/> <definition> <short value="Who, What, When for a set of resources"/> <formal value="Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance."/> <comments 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."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <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> </definition> </element> <element> <path value="Provenance.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal 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 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal 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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.contained"/> <definition> <short value="Contained, inline Resources"/> <formal 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."/> <comments 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."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.target"/> <definition> <short value="Target resource(s) (usually version specific)"/> <formal value="The resource(s) that were generated 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."/> <comments 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="*"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Any"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNo rmalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.wasGeneratedBy"/> </mapping> </definition> </element> <element> <path value="Provenance.period"/> <definition> <short value="When the activity occurred"/> <formal value="The period during which the activity occurred."/> <comments 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"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./effectiveTime[type=IVL_TS]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.startTime & Activity.endTime"/> </mapping> </definition> </element> <element> <path value="Provenance.recorded"/> <definition> <short value="When the activity was recorded / updated"/> <formal value="The instant of time at which the activity was recorded."/> <comments 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"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"/> </mapping> </definition> </element> <element> <path value="Provenance.reason"/> <definition> <short value="Reason the activity is occurring"/> <formal value="The reason that the activity was taking place."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="unique(./reasonCode)"/> </mapping> </definition> </element> <element> <path value="Provenance.location"/> <definition> <short value="Where the activity occurred, if relevant"/> <formal value="Where the activity occurred, if relevant."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Location"/> </type> <isModifier value="false"/> <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=& quot;INST"]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.location"/> </mapping> </definition> </element> <element> <path value="Provenance.policy"/> <definition> <short value="Policy or plan the activity was defined by"/> <formal 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."/> <min value="0"/> <max value="*"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <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> </definition> </element> <element> <path value="Provenance.agent"/> <definition> <short value="Person, organization, records, etc. involved in creating resource"/> <formal value="An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility."/> <comments value="Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.agent.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal 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 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.agent.role"/> <definition> <short value="e.g. author | overseer | enterer | attester | source | cc: +"/> <formal value="The role that the participant played."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceAgentRole"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/provenance-agent-role"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="attester: .[self::participation]/typeCode='RESP' author: .[self::participation]/typeCode='AUT' cc: .[self::participation]/typeCode='IRCP' enterer: .[self::participation]/typeCode='ENT' informant: .[self::participation]/typeCode='INF' performer: .[self::participation]/typeCode='PRF' verifier: .[self::participation]/typeCode='VRF' source: .[self::outboundRelationship]/typeCode=''"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.type"/> <definition> <short value="e.g. Resource | Person | Application | Record | Document +"/> <formal value="The type of the participant."/> <comments value="If the type is "Resource" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceAgentType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/provenance-agent-type"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="person: ./role[isNormalRole() and classCode='REL']/player[isNormalEntity and classCode='PER' and determinerCode='INST'] agent: ./role[isNormalRole() and classCode='ASSIGNED' and player[isNormal Entity and classCode='PSN' and determinerCode='INST']] organization: ./role[isNormalRole() and classCode='ASSIGNED' and not(player)]/scoper[isNormalEntity and classCode='ORG' and determinerCode='INST'] software: ./role[isNormalRole() and classCode='ASSIGNED']/scoper[isNormalEnt ity and classCode='DEV' and determinerCode='INST' and hasDomain(code, 'Software')] document: ./target[isNormalAct and subsumes('DOC', classCode) and moodCode='EVN']"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.reference"/> <definition> <short value="Identity of agent (urn or url)"/> <formal value="Identity of participant. May be a logical or physical uri and maybe absolute or relative."/> <comments value="identity may be a reference to a resource or to something else, depending on the type."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./id"/> </mapping> </definition> </element> <element> <path value="Provenance.agent.display"/> <definition> <short value="Human description of participant"/> <formal value="Human-readable description of the participant."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./player/description OR ./description OR ./text"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.label"/> </mapping> </definition> </element> <element> <path value="Provenance.entity"/> <definition> <short value="An entity used in this activity"/> <formal value="An entity used in this activity."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./subjectOf"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.entity.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal 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 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."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="Provenance.entity.role"/> <definition> <short value="derivation | revision | quotation | source"/> <formal value="How the entity was used during the activity."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceEntityRole"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/provenance-entity-role"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./typeCode"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.type"/> <definition> <short value="Resource Type, or something else"/> <formal value="The type of the entity. If the entity is a resource, then this is a resource type."/> <comments value="If the type is "resource" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant."/> <min value="1"/> <max value="1"/> <type> <code value="Coding"/> </type> <isModifier value="false"/> <binding> <name value="ProvenanceEntityType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/resource-types"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="./target"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.type"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.reference"/> <definition> <short value="Identity of participant (urn or url)"/> <formal value="Identity of participant. May be a logical or physical uri and maybe absolute or relative."/> <comments value="identity may be a reference to a resource or to something else, depending on the type."/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./text/reference"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.display"/> <definition> <short value="Human description of participant"/> <formal value="Human-readable description of the entity."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./title"/> </mapping> </definition> </element> <element> <path value="Provenance.entity.agent"/> <definition> <short value="Entity is attributed to this agent"/> <formal 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."/> <min value="0"/> <max value="1"/> <nameReference value="Provenance.agent"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./author/role"/> </mapping> </definition> </element> <element> <path value="Provenance.integritySignature"/> <definition> <short value="Base64 signature (DigSig) - integrity check"/> <formal value="A digital signature on the target resource(s). The signature should match a Provenance.agent.referen ce in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation."/> <comments value="Whether the content is XML or JSON, the representation is as a base64 of the XML signature of the resource."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="./signatureText"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="end"/> <type value="date"/> <documentation value="End time with inclusive boundary, if not ongoing"/> <xpath value="f:Provenance/f:period/f:end"/> </searchParam> <searchParam> <name value="location"/> <type value="reference"/> <documentation value="Where the activity occurred, if relevant"/> <xpath value="f:Provenance/f:location"/> </searchParam> <searchParam> <name value="party"/> <type value="token"/> <documentation value="Identity of agent (urn or url)"/> <xpath value="f:Provenance/f:agent/f:reference"/> </searchParam> <searchParam> <name value="partytype"/> <type value="token"/> <documentation value="e.g. Resource | Person | Application | Record | Document +"/> <xpath value="f:Provenance/f:agent/f:type"/> </searchParam> <searchParam> <name value="start"/> <type value="date"/> <documentation value="Starting time with inclusive boundary"/> <xpath value="f:Provenance/f:period/f:start"/> </searchParam> <searchParam> <name value="target"/> <type value="reference"/> <documentation value="Target resource(s) (usually version specific)"/> <xpath value="f:Provenance/f:target"/> </searchParam> </structure> </Profile>
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change