FHIR CI-Build
Security and PrivacyThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| Security Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
ProvenanceRelevantHistory
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="provenance-relevant-history"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <extension url="http://hl7.org/fhir/build/StructureDefinition/introduction"> <valueString value="provenance-relevant-history-introduction.xml"/> </extension> <extension url="http://hl7.org/fhir/build/StructureDefinition/notes"> <valueString value="provenance-relevant-history-notes.xml"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="3"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="sec"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/provenance-relevant-history"/> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:2.16.840.1.113883.4.642.5.1318"/> </identifier> <version value="6.0.0-ballot2"/> <name value="ProvenanceRelevantHistory"/> <title value="Provenance Relevant History"/> <status value="draft"/> <experimental value="false"/> <date value="2013-12-03"/> <publisher value="HL7 International / Security"/> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/Committees/fhir-i"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/secure"/> </telecom> </contact> <description value="Guidance on using Provenance for related history elements to provide key events that have happened over the lifespan of the resource - see the use of this pattern in the [Request Pattern](request.html#history)"/> <fhirVersion value="6.0.0-ballot2"/> <mapping> <identity value="workflow"/> <uri value="http://hl7.org/fhir/workflow"/> <name value="Workflow Pattern"/> </mapping> <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/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <mapping> <identity value="fhirauditevent"/> <uri value="http://hl7.org/fhir/auditevent"/> <name value="FHIR AuditEvent Mapping"/> </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"> <path value="Provenance"/> <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()"/> <source value="http://hl7.org/fhir/StructureDefinition/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 or SHALL refer to the containing resource"/> <expression value="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofTy pe(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmat ched', id).empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/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()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <key value="dom-5"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a security label"/> <expression value="contained.meta.security.empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."/> </extension> <key value="dom-6"/> <severity value="warning"/> <human value="A resource should have narrative for robust management"/> <expression value="text.`div`.exists()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Entity, Role, or Act,ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"/> </mapping> <mapping> <identity value="workflow"/> <map value="Event"/> </mapping> <mapping> <identity value="w5"/> <map value="infrastructure.information"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity"/> </mapping> </element> <element id="Provenance.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="Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Provenance.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 might 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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Provenance.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."/> <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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation"/> <isSummary value="true"/> </element> <element id="Provenance.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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <strength value="required"/> <description value="IETF language tag for a human language"/> <valueSet value="http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2"/> <additional> <purpose value="starter"/> <valueSet value="http://hl7.org/fhir/ValueSet/languages"/> </additional> </binding> </element> <element id="Provenance.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 can 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 a 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 information 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-6"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Provenance.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning."/> <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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels."/> <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> <condition value="dom-2"/> <condition value="dom-4"/> <condition value="dom-3"/> <condition value="dom-5"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/> <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."/> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)."/> <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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance.target"> <path value="Provenance.target"/> <short value="Resource version"/> <definition value="This points to the version of the resource that was created as a result of this historical record action. Typically only a single resource will be referenced, but if the same action is performed to multiple resources in the context of a transaction, some systems may link multiple resource instances."/> <comment value="The reference SHALL be version-specific."/> <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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormal Participation() 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> </element> <element id="Provenance.occurred[x]"> <path value="Provenance.occurred[x]"/> <short value="When the activity occurred"/> <definition value="This indicates the time the resource action (creation, revision, deletion, etc.) occurred."/> <comment value="Both low and high will be set to the time the record event occurred. (In a future version, this element will likely be a choice with dateTime so that multiple values aren't needed.)."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.occurred[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.occurrence"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.done[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="./effectiveTime[type=IVL_TS]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.startTime & Activity.endTime"/> </mapping> </element> <element id="Provenance.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="0"/> <max value="1"/> <base> <path value="Provenance.recorded"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.recorded"/> </mapping> <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> </element> <element id="Provenance.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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNorma lAct 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.location"> <path value="Provenance.location"/> <short value="Where the activity occurred"/> <definition value="Where the activity occurred."/> <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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.location"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.where[x]"/> </mapping> <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> </element> <element id="Provenance.authorization"> <path value="Provenance.authorization"/> <short value="Authorization (purposeOfUse) related to the event"/> <definition value="The authorization (e.g., PurposeOfUse) that was used during the event being recorded."/> <comment value="Plain text reasons can be sent in the "text" component with no codings. Domains may wish to define a constrained terminology. The authorization for the resource's existence of the resource itself will be maintained on the resource, not here."/> <requirements value="Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags."/> <alias value="PurposeOfEvent"/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.authorization"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableReference"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceReason"/> </extension> <strength value="example"/> <description value="The authorized purposeOfUse for the activity."/> <valueSet value="http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.reason"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./reasonCode)"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.purposeOfEvent"/> </mapping> </element> <element id="Provenance.why"> <path value="Provenance.why"/> <short value="Why was the event performed?"/> <definition value="Describes why the event recorded in this provenenace occurred in textual form."/> <alias value="reason"/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.why"/> <min value="0"/> <max value="1"/> </base> <type> <code value="markdown"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.reason"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./reasonCode)"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.Activity"/> </mapping> </element> <element id="Provenance.activity"> <path value="Provenance.activity"/> <short value="Record activity"/> <definition value="Indicates what action occurred to the referenced resource."/> <comment value="This should be captured at a sufficiently useful level of granularity. For example "suspended" is more useful than "updated". Domains will need to map the listed codes to their own state transitions and may wish to define additional domain-specific fine-grained codes."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.activity"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceHistoryRecordActivity"/> </extension> <strength value="extensible"/> <description value="Types of activities that are relevant for tracking event history using Provenance."/> <valueSet value="http://hl7.org/fhir/ValueSet/provenance-history-record-activity"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.code"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="Act.code"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.code"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.Activity"/> </mapping> </element> <element id="Provenance.basedOn"> <path value="Provenance.basedOn"/> <short value="Workflow authorization within which this event occurred"/> <definition value="A plan, proposal or order that is fulfilled in whole or in part by this provenance."/> <requirements value="Allows tracing of authorization for the provenance and tracking whether proposals/recommendat ions were acted upon."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.basedOn"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.basedOn"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="Act.code"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.Activity"/> </mapping> </element> <element id="Provenance.patient"> <path value="Provenance.patient"/> <short value="The patient is the subject of the data created/updated (.target) by the activity"/> <definition value="The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity."/> <requirements value="When the .patient is populated it shall be accurate to the subject of the target data. The .patient shall not be populated when the target data created/updated (.target) by the activity does not involve a subject. Note that when the patient is an agent, they will be recorded as an agent. When the Patient resource is Created, Updated, or Deleted it will be recorded as an entity. May also affect access control."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.patient"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.subject"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.subject[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="participation[typeCode=RTGT]"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.Identity"/> </mapping> </element> <element id="Provenance.encounter"> <path value="Provenance.encounter"/> <short value="Encounter within which this event occurred or which the event is tightly associated"/> <definition value="This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests)."/> <comment value="This will typically be the encounter the provenance was created during, but some provenances may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests)."/> <requirements value="Links the provenance to the Encounter context. May also affect access control."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.encounter"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.encounter"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value="Act.code"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.Activity"/> </mapping> </element> <element id="Provenance.agent"> <path value="Provenance.agent"/> <slicing> <discriminator> <type value="value"/> <path value="type"/> </discriminator> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Who was involved with change"/> <definition value="Who was involved with change."/> <comment value="Generally the author will be specified. Others are optional."/> <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() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="prov-1"/> <severity value="error"/> <human value="Who and onBehalfOf cannot be the same"/> <expression value="who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve()"/> <source value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </constraint> <constraint> <key value="prov-2"/> <severity value="error"/> <human value="If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner"/> <expression value="who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve ().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve()"/> <source value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </constraint> <constraint> <key value="prov-3"/> <severity value="error"/> <human value="If who is an organization, onBehalfOf can't be a PractitionerRole within that organization"/> <expression value="who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole) .organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.re solve()"/> <source value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.performer"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.who"/> </mapping> <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> </element> <element id="Provenance.agent.id"> <path value="Provenance.agent.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance.agent.modifierExtension"> <path value="Provenance.agent.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/> <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."/> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)."/> <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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance.agent.type"> <path value="Provenance.agent.type"/> <short value="How the agent participated"/> <definition value="The Functional Role of the agent with respect to the activity."/> <comment value="For example: assembler, author, prescriber, signer, investigator, etc."/> <requirements value="Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.agent.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceHistoryAgentType"/> </extension> <strength value="extensible"/> <description value="Types of roles that agents can play when tracking event history using Provenance."/> <valueSet value="http://hl7.org/fhir/ValueSet/provenance-history-agent-type"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.performer.function"/> </mapping> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent.type"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Attribution"/> </mapping> </element> <element id="Provenance.agent.role"> <path value="Provenance.agent.role"/> <short value="What the agents role was"/> <definition value="The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity."/> <comment value="For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc."/> <requirements value="Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.agent.role"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceAgentRole"/> </extension> <strength value="example"/> <description value="The role that a provenance agent played with respect to the activity."/> <valueSet value="http://hl7.org/fhir/ValueSet/security-role-type"/> </binding> <mapping> <identity value="rim"/> <map value=".typecode"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent.role"/> </mapping> </element> <element id="Provenance.agent.who"> <path value="Provenance.agent.who"/> <short value="The agent that participated in the event"/> <definition value="Indicates who or what performed in the event."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.agent.who"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <condition value="prov-1"/> <condition value="prov-2"/> <condition value="prov-3"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.performer.actor"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.author, FiveWs.source, FiveWs.actor, FiveWs.cause, FiveWs.witness, FiveWs.who,FiveWs.w ho"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element id="Provenance.agent.onBehalfOf"> <path value="Provenance.agent.onBehalfOf"/> <short value="The agent that delegated"/> <definition value="The agent that delegated authority to perform the activity performed by the agent.who element."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.agent.onBehalfOf"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <condition value="prov-1"/> <condition value="prov-2"/> <condition value="prov-3"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <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.agent:Author"> <path value="Provenance.agent"/> <sliceName value="Author"/> <short value="Author"/> <definition value="Author."/> <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="0"/> <max value="1"/> <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() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="prov-1"/> <severity value="error"/> <human value="Who and onBehalfOf cannot be the same"/> <expression value="who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve()"/> <source value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </constraint> <constraint> <key value="prov-2"/> <severity value="error"/> <human value="If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner"/> <expression value="who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve ().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve()"/> <source value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </constraint> <constraint> <key value="prov-3"/> <severity value="error"/> <human value="If who is an organization, onBehalfOf can't be a PractitionerRole within that organization"/> <expression value="who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole) .organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.re solve()"/> <source value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.performer"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.who"/> </mapping> <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> </element> <element id="Provenance.agent:Author.id"> <path value="Provenance.agent.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance.agent:Author.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance.agent:Author.modifierExtension"> <path value="Provenance.agent.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/> <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."/> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)."/> <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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance.agent:Author.type"> <path value="Provenance.agent.type"/> <short value="How the agent participated"/> <definition value="The Functional Role of the agent with respect to the activity."/> <comment value="For example: assembler, author, prescriber, signer, investigator, etc."/> <requirements value="Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.agent.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <patternCodeableConcept> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> <code value="AUT"/> </coding> </patternCodeableConcept> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceAgentType"/> </extension> <strength value="example"/> <description value="The type of participation that a provenance agent played with respect to the activity."/> <valueSet value="http://hl7.org/fhir/ValueSet/participation-role-type"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.performer.function"/> </mapping> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent.type"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Attribution"/> </mapping> </element> <element id="Provenance.agent:Author.role"> <path value="Provenance.agent.role"/> <short value="What the agents role was"/> <definition value="The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity."/> <comment value="For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc."/> <requirements value="Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.."/> <min value="0"/> <max value="*"/> <base> <path value="Provenance.agent.role"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceAgentRole"/> </extension> <strength value="example"/> <description value="The role that a provenance agent played with respect to the activity."/> <valueSet value="http://hl7.org/fhir/ValueSet/security-role-type"/> </binding> <mapping> <identity value="rim"/> <map value=".typecode"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.agent.role"/> </mapping> </element> <element id="Provenance.agent:Author.who"> <path value="Provenance.agent.who"/> <short value="Author Reference"/> <definition value="Author Reference."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.agent.who"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <condition value="prov-1"/> <condition value="prov-2"/> <condition value="prov-3"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.performer.actor"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.author, FiveWs.source, FiveWs.actor, FiveWs.cause, FiveWs.witness, FiveWs.who,FiveWs.w ho"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element id="Provenance.agent:Author.onBehalfOf"> <path value="Provenance.agent.onBehalfOf"/> <short value="The agent that delegated"/> <definition value="The agent that delegated authority to perform the activity performed by the agent.who element."/> <min value="0"/> <max value="1"/> <base> <path value="Provenance.agent.onBehalfOf"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <condition value="prov-1"/> <condition value="prov-2"/> <condition value="prov-3"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <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.entity"> <path value="Provenance.entity"/> <short value="An entity used in this activity"/> <definition value="An entity used in this activity."/> <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() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <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.entity.id"> <path value="Provenance.entity.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Provenance.entity.modifierExtension"> <path value="Provenance.entity.modifierExtension"/> <short value="Extensions that cannot be ignored even if unrecognized"/> <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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/> <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."/> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)."/> <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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Provenance.entity.role"> <path value="Provenance.entity.role"/> <short value="revision | quotation | source | instantiates | 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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <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."/> <valueSet value="http://hl7.org/fhir/ValueSet/provenance-entity-role|6.0.0-ballot2"/> </binding> <mapping> <identity value="rim"/> <map value="./typeCode"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.entity.role"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.role"/> </mapping> </element> <element id="Provenance.entity.what"> <path value="Provenance.entity.what"/> <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="whatIdentity should be used for entities that are not a Resource type."/> <min value="1"/> <max value="1"/> <base> <path value="Provenance.entity.what"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <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.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 used 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="http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="./author/role"/> </mapping> <mapping> <identity value="fhirauditevent"/> <map value="AuditEvent.entity.agent"/> </mapping> </element> <element id="Provenance.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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="./signatureText"/> </mapping> </element> </snapshot> <differential> <element id="Provenance"> <path value="Provenance"/> <min value="0"/> <max value="*"/> </element> <element id="Provenance.target"> <path value="Provenance.target"/> <short value="Resource version"/> <definition value="This points to the version of the resource that was created as a result of this historical record action. Typically only a single resource will be referenced, but if the same action is performed to multiple resources in the context of a transaction, some systems may link multiple resource instances."/> <comment value="The reference SHALL be version-specific."/> <mustSupport value="true"/> </element> <element id="Provenance.occurred[x]"> <path value="Provenance.occurred[x]"/> <definition value="This indicates the time the resource action (creation, revision, deletion, etc.) occurred."/> <comment value="Both low and high will be set to the time the record event occurred. (In a future version, this element will likely be a choice with dateTime so that multiple values aren't needed.)."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <mustSupport value="true"/> </element> <element id="Provenance.authorization"> <path value="Provenance.authorization"/> <comment value="Plain text reasons can be sent in the "text" component with no codings. Domains may wish to define a constrained terminology. The authorization for the resource's existence of the resource itself will be maintained on the resource, not here."/> <mustSupport value="true"/> </element> <element id="Provenance.activity"> <path value="Provenance.activity"/> <short value="Record activity"/> <definition value="Indicates what action occurred to the referenced resource."/> <comment value="This should be captured at a sufficiently useful level of granularity. For example "suspended" is more useful than "updated". Domains will need to map the listed codes to their own state transitions and may wish to define additional domain-specific fine-grained codes."/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceHistoryRecordActivity"/> </extension> <strength value="extensible"/> <description value="Types of activities that are relevant for tracking event history using Provenance."/> <valueSet value="http://hl7.org/fhir/ValueSet/provenance-history-record-activity"/> </binding> </element> <element id="Provenance.agent"> <path value="Provenance.agent"/> <slicing> <discriminator> <type value="value"/> <path value="type"/> </discriminator> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Who was involved with change"/> <definition value="Who was involved with change."/> <comment value="Generally the author will be specified. Others are optional."/> <mustSupport value="true"/> </element> <element id="Provenance.agent.type"> <path value="Provenance.agent.type"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProvenanceHistoryAgentType"/> </extension> <strength value="extensible"/> <description value="Types of roles that agents can play when tracking event history using Provenance."/> <valueSet value="http://hl7.org/fhir/ValueSet/provenance-history-agent-type"/> </binding> </element> <element id="Provenance.agent:Author"> <path value="Provenance.agent"/> <sliceName value="Author"/> <short value="Author"/> <definition value="Author."/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> </element> <element id="Provenance.agent:Author.type"> <path value="Provenance.agent.type"/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <patternCodeableConcept> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> <code value="AUT"/> </coding> </patternCodeableConcept> <mustSupport value="true"/> </element> <element id="Provenance.agent:Author.who"> <path value="Provenance.agent.who"/> <short value="Author Reference"/> <definition value="Author Reference."/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> </element> </differential> </StructureDefinition>
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Wed, Nov 20, 2024 21:52+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change