Release 5 Preview #1
This page is part of the FHIR Specification (v4.2.0: R5 Preview #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: R4 R3 R2
| Electronic Health Records Work Group | Maturity Level: 1 | Trial Use | Use Context: Any |
ehrsrle-auditevent
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="ehrsrle-auditevent"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="ehr"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent"/> <version value="4.2.0"/> <name value="EHRS FM Record Lifecycle Event - Audit Event"/> <status value="draft"/> <experimental value="false"/> <date value="2014-12-04"/> <publisher value="Health Level Seven International (Electronic Health Record)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/special/committees/ehr.html"/> </telecom> </contact> <description value="Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard"/> <fhirVersion value="4.2.0"/> <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="dicom"/> <uri value="http://nema.org/dicom"/> <name value="DICOM Tag Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <mapping> <identity value="w3c.prov"/> <uri value="http://www.w3.org/ns/prov"/> <name value="W3C PROV"/> </mapping> <mapping> <identity value="fhirprovenance"/> <uri value="http://hl7.org/fhir/provenance"/> <name value="FHIR Provenance Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="AuditEvent"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/AuditEvent"/> <derivation value="constraint"/> <snapshot> <element id="AuditEvent"> <path value="AuditEvent"/> <short value="Record of an event"/> <definition value="A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis."/> <comment value="Based on IHE-ATNA."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-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().as(canonica l) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(refer ence = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(c anonical) = '#').exists()).not()).trace('unmatched', id).empty()"/> <xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:refere nce/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-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()"/> <xpath value="not(exists(f:contained/*/f:meta/f:security))"/> <source value="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()"/> <xpath value="exists(f:text/h:div)"/> <source value="DomainResource"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="workflow"/> <map value="Event"/> </mapping> <mapping> <identity value="rim"/> <map value="ControlAct[moodCode=EVN]"/> </mapping> <mapping> <identity value="dicom"/> <map value="Message"/> </mapping> </element> <element id="AuditEvent.id"> <path value="AuditEvent.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUri value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="AuditEvent.meta"> <path value="AuditEvent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="AuditEvent.implicitRules"> <path value="AuditEvent.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 it's 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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <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 it's meaning or interpretation"/> <isSummary value="true"/> </element> <element id="AuditEvent.language"> <path value="AuditEvent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="preferred"/> <description value="A human language."/> <valueSet value="http://hl7.org/fhir/ValueSet/languages"/> </binding> </element> <element id="AuditEvent.text"> <path value="AuditEvent.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 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> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="AuditEvent.contained"> <path value="AuditEvent.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. 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> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="AuditEvent.extension"> <path value="AuditEvent.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 manageable, 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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="AuditEvent.modifierExtension"> <path value="AuditEvent.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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](http://hl7.org/f hir/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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </constraint> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="AuditEvent.type"> <path value="AuditEvent.type"/> <short value="Type/identifier of event"/> <definition value="Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function."/> <requirements value="This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed."/> <min value="1"/> <max value="1"/> <base> <path value="AuditEvent.type"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventType"/> </extension> <strength value="extensible"/> <description value="Type of event."/> <valueSet value="http://hl7.org/fhir/ValueSet/audit-event-type"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.code"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventId"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity"/> </mapping> </element> <element id="AuditEvent.subtype"> <path value="AuditEvent.subtype"/> <short value="More specific type/id for the event"/> <definition value="Identifier for the category of event."/> <requirements value="This field enables queries of messages by implementation-defined event categories."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.subtype"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventSubType"/> </extension> <strength value="extensible"/> <description value="Sub-type of event."/> <valueSet value="http://hl7.org/fhir/ValueSet/audit-event-sub-type"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventTypeCode"/> </mapping> </element> <element id="AuditEvent.action"> <path value="AuditEvent.action"/> <short value="Type of action performed during the event"/> <definition value="Indicator for type of action performed during the event that generated the audit."/> <requirements value="This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent ."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.action"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventAction"/> </extension> <strength value="required"/> <description value="Indicator for type of action performed during the event that generated the event."/> <valueSet value="http://hl7.org/fhir/ValueSet/audit-event-action|4.2.0"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventActionCode"/> </mapping> </element> <element id="AuditEvent.severity"> <path value="AuditEvent.severity"/> <short value="Emergency | Alert | Critical | Error | Warning | Notice | Informational | Debug"/> <definition value="Indicates and enables segmentation of various severity including debugging from critical."/> <comment value="ATNA will map this to the SYSLOG PRI element."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.severity"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventSeverity"/> </extension> <strength value="required"/> <description value="The severity of the audit entry."/> <valueSet value="http://hl7.org/fhir/ValueSet/audit-event-severity|4.2.0"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="dicom"/> <map value="PRI"/> </mapping> </element> <element id="AuditEvent.period"> <path value="AuditEvent.period"/> <short value="When the activity occurred"/> <definition value="The period during which the activity occurred."/> <comment value="The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.occurred[x]"/> </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> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.occurred[x]"/> </mapping> </element> <element id="AuditEvent.recorded"> <path value="AuditEvent.recorded"/> <short value="Time when the event was recorded"/> <definition value="The time when the event was recorded."/> <comment value="In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic."/> <requirements value="This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution."/> <min value="1"/> <max value="1"/> <base> <path value="AuditEvent.recorded"/> <min value="1"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.recorded"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventDateTime"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.when"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.recorded"/> </mapping> </element> <element id="AuditEvent.outcome"> <path value="AuditEvent.outcome"/> <short value="Whether the event succeeded or failed"/> <definition value="Indicates whether the event succeeded or failed."/> <comment value="In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.outcome"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventOutcome"/> </extension> <strength value="required"/> <description value="Indicates whether the event succeeded or failed."/> <valueSet value="http://hl7.org/fhir/ValueSet/audit-event-outcome|4.2.0"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".actionNegationInd"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventOutcomeIndicator"/> </mapping> </element> <element id="AuditEvent.outcomeDesc"> <path value="AuditEvent.outcomeDesc"/> <short value="Description of the event outcome"/> <definition value="A free text description of the outcome of the event."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.outcomeDesc"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=OUT].target.text"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventOutcomeDescription"/> </mapping> </element> <element id="AuditEvent.purposeOfEvent"> <path value="AuditEvent.purposeOfEvent"/> <short value="The purposeOfUse of the event"/> <definition value="The purposeOfUse (reason) that was used during the event being recorded."/> <comment value="Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why."/> <requirements value="record of any relevant security context not restricted to purposeOfUse valueSet, may include security compartments or other security tags."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.purposeOfEvent"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditPurposeOfUse"/> </extension> <strength value="extensible"/> <description value="The reason the activity took place."/> <valueSet value="http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.reasonCode"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="* .reasonCode [ControlActReason when Act.class = CACT Control Act] *.outboundRelationship[typeCode=RSON].target"/> </mapping> <mapping> <identity value="dicom"/> <map value="EventPurposeOfUse"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.Activity"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.reason, Provenance.activity"/> </mapping> </element> <element id="AuditEvent.agent"> <path value="AuditEvent.agent"/> <short value="Actor involved in the event"/> <definition value="An actor taking an active role in the event or activity that is logged."/> <comment value="Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity."/> <requirements value="An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility."/> <alias value="ActiveParticipant"/> <min value="1"/> <max value="*"/> <base> <path value="AuditEvent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <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"/> </mapping> <mapping> <identity value="dicom"/> <map value="ActiveParticipant"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.agent"/> </mapping> </element> <element id="AuditEvent.agent.id"> <path value="AuditEvent.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"> <valueUri value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.agent.extension"> <path value="AuditEvent.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 manageable, 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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.agent.modifierExtension"> <path value="AuditEvent.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 manageable, 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](http://hl7.org/f hir/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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </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="AuditEvent.agent.type"> <path value="AuditEvent.agent.type"/> <short value="How agent participated"/> <definition value="Specification of the participation type the user plays when performing the event."/> <comment value="The most relevant role code for how the agent participated in the activity."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditAgentType"/> </extension> <strength value="extensible"/> <description value="The Participation type of the agent to the event."/> <valueSet value="http://hl7.org/fhir/ValueSet/participation-role-type"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.performer.function"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.who"/> </mapping> <mapping> <identity value="rim"/> <map value=".typeCode and/or .functionCode"/> </mapping> <mapping> <identity value="dicom"/> <map value="prime RoleIdCode"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Attribution"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.agent.type"/> </mapping> </element> <element id="AuditEvent.agent.role"> <path value="AuditEvent.agent.role"/> <short value="Agent role in the event"/> <definition value="The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context."/> <comment value="Should be all the relevant roles (Functional and Structural) inclusive of the value in .agent.type."/> <requirements value="This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditAgentRole"/> </extension> <strength value="example"/> <description value="What security role enabled the agent to participate in the event."/> <valueSet value="http://hl7.org/fhir/ValueSet/security-role-type"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.who"/> </mapping> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> <mapping> <identity value="dicom"/> <map value="all RoleIdCode"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Attribution"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.agent.role"/> </mapping> </element> <element id="AuditEvent.agent.who"> <path value="AuditEvent.agent.who"/> <short value="Identifier of who"/> <definition value="Reference to who this agent is that was involved in the event."/> <comment value="Where a User ID is available it will go into who.identifier."/> <requirements value="This field ties an audit event to a specific resource or identifier."/> <alias value="userId"/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.who"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="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.who"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="UserId"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Identity"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.agent.who"/> </mapping> </element> <element id="AuditEvent.agent.altId"> <path value="AuditEvent.agent.altId"/> <short value="Alternative User identity"/> <definition value="Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available."/> <requirements value="In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.altId"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.who"/> </mapping> <mapping> <identity value="rim"/> <map value=".id (distinguish id type by root)"/> </mapping> <mapping> <identity value="dicom"/> <map value="AlternativeUserId"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Identity"/> </mapping> </element> <element id="AuditEvent.agent.name"> <path value="AuditEvent.agent.name"/> <short value="Human friendly name for the agent"/> <definition value="Human-meaningful name for the agent."/> <requirements value="The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.who"/> </mapping> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> <mapping> <identity value="dicom"/> <map value="UserName"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Identity"/> </mapping> </element> <element id="AuditEvent.agent.requestor"> <path value="AuditEvent.agent.requestor"/> <short value="Whether user is initiator"/> <definition value="Indicator that the user is or is not the requestor, or initiator, for the event being audited."/> <comment value="There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator."/> <requirements value="This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user."/> <min value="1"/> <max value="1"/> <base> <path value="AuditEvent.agent.requestor"/> <min value="1"/> <max value="1"/> </base> <type> <code value="boolean"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.who"/> </mapping> <mapping> <identity value="rim"/> <map value="If participation.typeCode was author, then true"/> </mapping> <mapping> <identity value="dicom"/> <map value="UserIsRequestor"/> </mapping> </element> <element id="AuditEvent.agent.location"> <path value="AuditEvent.agent.location"/> <short value="Where"/> <definition value="Where the event occurred."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <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="* Role.Class =SDLOC *Role.Code = ServiceDeliveryLocationRoleType *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC *EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant."/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Activity.location"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.location"/> </mapping> </element> <element id="AuditEvent.agent.policy"> <path value="AuditEvent.agent.policy"/> <short value="Policy that authorized event"/> <definition value="The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used."/> <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."/> <requirements value="This value is used retrospectively to determine the authorization policies."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.agent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="ActPolicyType"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantRoleIDCode"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.policy"/> </mapping> </element> <element id="AuditEvent.agent.media"> <path value="AuditEvent.agent.media"/> <short value="Type of media"/> <definition value="Type of media involved. Used when the event is about exporting/importing onto media."/> <requirements value="Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD)."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.media"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DICOMMediaType"/> </extension> <strength value="extensible"/> <description value="Used when the event is about exporting/importing onto media."/> <valueSet value="http://hl7.org/fhir/ValueSet/dicm-405-mediatype"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.where[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".player.description.mediaType"/> </mapping> <mapping> <identity value="dicom"/> <map value="MediaType"/> </mapping> </element> <element id="AuditEvent.agent.network"> <path value="AuditEvent.agent.network"/> <short value="Logical network location for application activity"/> <definition value="Logical network location for application activity, if the activity has a network location."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.network"/> <min value="0"/> <max value="1"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.where[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".player.description.reference"/> </mapping> </element> <element id="AuditEvent.agent.network.id"> <path value="AuditEvent.agent.network.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"> <valueUri value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.agent.network.extension"> <path value="AuditEvent.agent.network.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 manageable, 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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.agent.network.modifierExtension"> <path value="AuditEvent.agent.network.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 manageable, 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](http://hl7.org/f hir/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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </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="AuditEvent.agent.network.address"> <path value="AuditEvent.agent.network.address"/> <short value="Identifier for the network access point of the user device"/> <definition value="An identifier for the network access point of the user device for the audit event."/> <comment value="This could be a device id, IP address or some other identifier associated with a device."/> <requirements value="This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.network.address"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.where[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> <mapping> <identity value="dicom"/> <map value="NetworkAccessPointID"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Location"/> </mapping> </element> <element id="AuditEvent.agent.network.type"> <path value="AuditEvent.agent.network.type"/> <short value="The type of network access point"/> <definition value="An identifier for the type of network access point that originated the audit event."/> <requirements value="This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.agent.network.type"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventAgentNetworkType"/> </extension> <strength value="required"/> <description value="The type of network access point of this agent in the audit event."/> <valueSet value="http://hl7.org/fhir/ValueSet/network-type|4.2.0"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.where[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> <mapping> <identity value="dicom"/> <map value="NetworkAccessPointTypeCode"/> </mapping> </element> <element id="AuditEvent.agent.purposeOfUse"> <path value="AuditEvent.agent.purposeOfUse"/> <short value="Reason given for this user"/> <definition value="The reason (purpose of use), specific to this agent, that was used during the event being recorded."/> <comment value="Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why."/> <requirements value="record of any relevant security context not restricted to purposeOfUse valueSet, may include security compartments or other security tags."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.agent.purposeOfUse"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditPurposeOfUse"/> </extension> <strength value="extensible"/> <description value="The reason the activity took place."/> <valueSet value="http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="*.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse (2.16.840.1.113883.1.11.20448) * .outboundRelationship[typeCode=RSON or SUBJ].target"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Agent.Activity"/> </mapping> </element> <element id="AuditEvent.source"> <path value="AuditEvent.source"/> <short value="Audit Event Reporter"/> <definition value="The system that is reporting the event."/> <comment value="Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified."/> <requirements value="The event is reported by one source."/> <min value="1"/> <max value="1"/> <base> <path value="AuditEvent.source"/> <min value="1"/> <max value="1"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.witness"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"/> </mapping> <mapping> <identity value="dicom"/> <map value="AuditSourceIdentification"/> </mapping> </element> <element id="AuditEvent.source.id"> <path value="AuditEvent.source.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"> <valueUri value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.source.extension"> <path value="AuditEvent.source.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 manageable, 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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.source.modifierExtension"> <path value="AuditEvent.source.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 manageable, 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](http://hl7.org/f hir/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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </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="AuditEvent.source.site"> <path value="AuditEvent.source.site"/> <short value="Logical source location within the enterprise"/> <definition value="Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group."/> <requirements value="This value differentiates among the sites in a multi-site enterprise health information system."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.source.site"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.witness"/> </mapping> <mapping> <identity value="rim"/> <map value=".scopedRole[classCode=LOCE].player.desc"/> </mapping> <mapping> <identity value="dicom"/> <map value="AuditEnterpriseSiteId"/> </mapping> </element> <element id="AuditEvent.source.observer"> <path value="AuditEvent.source.observer"/> <short value="The identity of source detecting the event"/> <definition value="Identifier of the source where the event was detected."/> <requirements value="This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected."/> <alias value="SourceId"/> <min value="1"/> <max value="1"/> <base> <path value="AuditEvent.source.observer"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.witness"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="AuditSourceId"/> </mapping> </element> <element id="AuditEvent.source.type"> <path value="AuditEvent.source.type"/> <short value="The type of source where event originated"/> <definition value="Code specifying the type of source where event originated."/> <requirements value="This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.source.type"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventSourceType"/> </extension> <strength value="extensible"/> <description value="Code specifying the type of system that detected and recorded the event."/> <valueSet value="http://hl7.org/fhir/ValueSet/audit-source-type"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.witness"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="dicom"/> <map value="AuditSourceTypeCode"/> </mapping> </element> <element id="AuditEvent.entity"> <path value="AuditEvent.entity"/> <short value="Data or objects used"/> <definition value="Specific instances of data or objects that have been accessed."/> <comment value="Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values."/> <requirements value="The event may have other entities involved."/> <alias value="ParticipantObject"/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="sev-1"/> <severity value="error"/> <human value="Either a name or a query (NOT both)"/> <expression value="name.empty() or query.empty()"/> <xpath value="not(exists(f:name)) or not(exists(f:query))"/> <source value="http://hl7.org/fhir/StructureDefinition/AuditEvent"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectIdentification"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.target, Provenance.entity"/> </mapping> </element> <element id="AuditEvent.entity.id"> <path value="AuditEvent.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"> <valueUri value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.entity.extension"> <path value="AuditEvent.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 manageable, 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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.entity.modifierExtension"> <path value="AuditEvent.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 manageable, 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](http://hl7.org/f hir/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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </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="AuditEvent.entity.what"> <path value="AuditEvent.entity.what"/> <short value="Specific instance of resource"/> <definition value="Identifies a specific instance of the entity. The reference should be version specific."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.entity.what"/> <min value="0"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="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=".id"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectID and ParticipantObjectIDTypeCode"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.target, Provenance.entity.what"/> </mapping> </element> <element id="AuditEvent.entity.type"> <path value="AuditEvent.entity.type"/> <short value="Type of entity involved"/> <definition value="The type of the object that was involved in this audit event."/> <comment value="This value is distinct from the user's role or any user relationship to the entity."/> <requirements value="To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.entity.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventEntityType"/> </extension> <strength value="extensible"/> <description value="Code for the entity type involved in the audit event."/> <valueSet value="http://hl7.org/fhir/ValueSet/audit-entity-type"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> <mapping> <identity value="rim"/> <map value="[self::Act].code or role.player.code"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectTypeCode"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.type"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.entity.type"/> </mapping> </element> <element id="AuditEvent.entity.role"> <path value="AuditEvent.entity.role"/> <short value="What role the entity played"/> <definition value="Code representing the role the entity played in the event being audited."/> <requirements value="For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.entity.role"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventEntityRole"/> </extension> <strength value="extensible"/> <description value="Code representing the role the entity played in the audit event."/> <valueSet value="http://hl7.org/fhir/ValueSet/object-role"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value="role.code (not sure what this would mean for an Act)"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectTypeCodeRole"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.role"/> </mapping> </element> <element id="AuditEvent.entity.lifecycle"> <path value="AuditEvent.entity.lifecycle"/> <short value="Life-cycle stage for the entity"/> <definition value="Identifier for the data life-cycle stage for the entity."/> <comment value="This can be used to provide an audit trail for data, over time, as it passes through the system."/> <requirements value="Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.entity.lifecycle"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AuditEventEntityLifecycle"/> </extension> <strength value="extensible"/> <description value="Identifier for the data life-cycle stage for the entity."/> <valueSet value="http://hl7.org/fhir/ValueSet/object-lifecycle-events"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value="target of ObservationEvent[code="lifecycle"].value"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDataLifeCycle"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.role"/> </mapping> <mapping> <identity value="fhirprovenance"/> <map value="Provenance.entity.role"/> </mapping> </element> <element id="AuditEvent.entity.securityLabel"> <path value="AuditEvent.entity.securityLabel"/> <short value="Security labels on the entity"/> <definition value="Security labels for the identified entity."/> <comment value="Copied from entity meta security tags."/> <requirements value="This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.entity.securityLabel"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Coding"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SecurityLabels"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="Security Labels from the Healthcare Privacy and Security Classification System."/> <valueSet value="http://hl7.org/fhir/ValueSet/security-labels"/> </binding> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectSensitivity"/> </mapping> </element> <element id="AuditEvent.entity.name"> <path value="AuditEvent.entity.name"/> <short value="Descriptor for entity"/> <definition value="A name of the entity in the audit event."/> <comment value="This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used."/> <requirements value="Use only where entity can't be identified with an identifier."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.entity.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <condition value="sev-1"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectName"/> </mapping> <mapping> <identity value="w3c.prov"/> <map value="Entity.Label"/> </mapping> </element> <element id="AuditEvent.entity.query"> <path value="AuditEvent.entity.query"/> <short value="Query parameters"/> <definition value="The query parameters for a query-type entities."/> <comment value="The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob."/> <requirements value="For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing."/> <min value="0"/> <max value="1"/> <base> <path value="AuditEvent.entity.query"/> <min value="0"/> <max value="1"/> </base> <type> <code value="base64Binary"/> </type> <condition value="sev-1"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value="No mapping"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectQuery"/> </mapping> </element> <element id="AuditEvent.entity.detail"> <path value="AuditEvent.entity.detail"/> <short value="Additional Information about the entity"/> <definition value="Tagged value pairs for conveying additional information about the entity."/> <requirements value="Implementation-defined data about specific details of the object accessed or used."/> <min value="0"/> <max value="*"/> <base> <path value="AuditEvent.entity.detail"/> <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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDetail"/> </mapping> </element> <element id="AuditEvent.entity.detail.id"> <path value="AuditEvent.entity.detail.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"> <valueUri value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.entity.detail.extension"> <path value="AuditEvent.entity.detail.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 manageable, 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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="AuditEvent.entity.detail.modifierExtension"> <path value="AuditEvent.entity.detail.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 manageable, 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](http://hl7.org/f hir/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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/> <source value="Extension"/> </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="AuditEvent.entity.detail.type"> <path value="AuditEvent.entity.detail.type"/> <short value="Name of the property"/> <definition value="The type of extra detail provided in the value."/> <min value="1"/> <max value="1"/> <base> <path value="AuditEvent.entity.detail.type"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDetail.type"/> </mapping> </element> <element id="AuditEvent.entity.detail.value[x]"> <path value="AuditEvent.entity.detail.value[x]"/> <short value="Property value"/> <definition value="The value of the extra detail."/> <comment value="The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.typ e, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob."/> <requirements value="Should not duplicate the entity value unless absolutely necessary."/> <min value="1"/> <max value="1"/> <base> <path value="AuditEvent.entity.detail.value[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <type> <code value="base64Binary"/> </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())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDetail.value"/> </mapping> </element> </snapshot> <differential> <element id="AuditEvent"> <path value="AuditEvent"/> <min value="0"/> <max value="*"/> </element> <element id="AuditEvent.type"> <path value="AuditEvent.type"/> <mustSupport value="true"/> </element> <element id="AuditEvent.subtype"> <path value="AuditEvent.subtype"/> <mustSupport value="true"/> </element> <element id="AuditEvent.action"> <path value="AuditEvent.action"/> <mustSupport value="true"/> </element> <element id="AuditEvent.recorded"> <path value="AuditEvent.recorded"/> <mustSupport value="true"/> </element> <element id="AuditEvent.purposeOfEvent"> <path value="AuditEvent.purposeOfEvent"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent"> <path value="AuditEvent.agent"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.role"> <path value="AuditEvent.agent.role"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.who"> <path value="AuditEvent.agent.who"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.requestor"> <path value="AuditEvent.agent.requestor"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.location"> <path value="AuditEvent.agent.location"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.policy"> <path value="AuditEvent.agent.policy"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.network"> <path value="AuditEvent.agent.network"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.network.address"> <path value="AuditEvent.agent.network.address"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.network.type"> <path value="AuditEvent.agent.network.type"/> <mustSupport value="true"/> </element> <element id="AuditEvent.agent.purposeOfUse"> <path value="AuditEvent.agent.purposeOfUse"/> <mustSupport value="true"/> </element> <element id="AuditEvent.source"> <path value="AuditEvent.source"/> <mustSupport value="true"/> </element> <element id="AuditEvent.source.site"> <path value="AuditEvent.source.site"/> <mustSupport value="true"/> </element> <element id="AuditEvent.source.observer"> <path value="AuditEvent.source.observer"/> <mustSupport value="true"/> </element> <element id="AuditEvent.source.type"> <path value="AuditEvent.source.type"/> <mustSupport value="true"/> </element> <element id="AuditEvent.entity"> <path value="AuditEvent.entity"/> <mustSupport value="true"/> </element> <element id="AuditEvent.entity.what"> <path value="AuditEvent.entity.what"/> <mustSupport value="true"/> </element> <element id="AuditEvent.entity.type"> <path value="AuditEvent.entity.type"/> <mustSupport value="true"/> </element> <element id="AuditEvent.entity.role"> <path value="AuditEvent.entity.role"/> <mustSupport value="true"/> </element> <element id="AuditEvent.entity.lifecycle"> <path value="AuditEvent.entity.lifecycle"/> <mustSupport value="true"/> </element> <element id="AuditEvent.entity.securityLabel"> <path value="AuditEvent.entity.securityLabel"/> <mustSupport value="true"/> </element> </differential> </StructureDefinition>
FHIR ®© HL7.org 2011+. FHIR CI Build hl7.fhir.core#4.2.0 (GitHub f996518d66) generated on Tue, Dec 31, 2019 21:19+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change