Event.xml

Logical Model Event

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Event"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">to do</div> 
  </text> 
  <url value="http://hl7.org/fhir/StructureDefinition/Event"/> 
  <name value="Event"/> 
  <title value="event"/> 
  <status value="draft"/> 
  <date value="2019-10-24T11:53:00+11:00"/> 
  <publisher value="Health Level Seven International fhir"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="Logical Model: A pattern to be followed by resources that represent the performance of
   some activity, possibly in accordance with a request or service definition."/> 
  <fhirVersion value="3.0.2"/> 
  <mapping> 
    <identity value="v2"/> 
    <uri value="http://hl7.org/v2"/> 
    <name value="HL7 v2 Mapping"/> 
  </mapping> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <mapping> 
    <identity value="w5"/> 
    <uri value="http://hl7.org/fhir/w5"/> 
    <name value="W5 Mapping"/> 
  </mapping> 
  <kind value="logical"/> 
  <abstract value="false"/> 
  <snapshot> 
    <element id="Event">
      <path value="Event"/> 
      <short value="Event Pattern"/> 
      <definition value="A pattern to be followed by resources that represent the performance of some activity,
       possibly in accordance with a request or service definition."/> 
      <min value="0"/> 
      <max value="*"/> 
      <constraint> 
        <key value="inv-1"/> 
        <severity value="error"/> 
        <human value="Not Done Reason can only be specified if NotDone is &quot;true&quot;"/> 
        <expression value="notDone or notDoneReason.exists().not()"/> 
        <xpath value="f:notDone/@value=true() or not(exists(f:notDoneReason))"/> 
      </constraint> 
      <mapping> 
        <identity value="v2"/> 
        <map value="EVN (for administrative events)"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="Act[moodCode=EVN]"/> 
      </mapping> 
    </element> 
    <element id="Event.identifier">
      <path value="Event.identifier"/> 
      <short value="Business Identifier for event"/> 
      <definition value="Identifiers assigned to this event performer or other systems."/> 
      <requirements value="Allows identification of the event as it is known by various participating systems and
       in a way that remains consistent across servers."/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="Identifier"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".identifier"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="id"/> 
      </mapping> 
    </element> 
    <element id="Event.definition">
      <path value="Event.definition"/> 
      <short value="Instantiates protocol or definition"/> 
      <definition value="A protocol, guideline, orderset or other definition that was adhered to in whole or in
       part by this event."/> 
      <comment value="[The allowed reference resources may be adjusted as appropriate for the event resource]."/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Definition"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".outboundRelationship[typeCode=DEFN].target"/> 
      </mapping> 
    </element> 
    <element id="Event.basedOn">
      <path value="Event.basedOn"/> 
      <short value="Fulfills plan, proposal or order"/> 
      <definition value="A plan, proposal or order that is fulfilled in whole or in part by this event."/> 
      <comment value="[The allowed reference resources may be adjusted as appropriate for the event resource]."/> 
      <requirements value="Allows tracing of authorization for the event and tracking whether proposals/recommendations
       were acted upon."/> 
      <alias value="fulfills"/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Request"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="ORC in proximity to EVN segment"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".outboundRelationship[typeCode=FLFS].target"/> 
      </mapping> 
    </element> 
    <element id="Event.partOf">
      <path value="Event.partOf"/> 
      <short value="Part of referenced event"/> 
      <definition value="A larger event of which this particular event is a component or step."/> 
      <comment value="Not to be used to link an event to an Encounter - use Event.context for that.

[The allowed reference resources may be adjusted as appropriate for the event resource]."/> 
      <requirements value="E.g. Drug administration as part of a procedure, procedure as part of observation, etc."/> 
      <alias value="container"/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Event"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"/> 
      </mapping> 
    </element> 
    <element id="Event.status">
      <path value="Event.status"/> 
      <short value="preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown"/> 
      <definition value="The current state of the event."/> 
      <comment value="A nominal state-transition diagram can be found in the [[event.html#statemachine | Event
       pattern]] documentation

Unknown does not represent &quot;other&quot; - one of the defined statuses must apply.
        Unknown is used when the authoring system is not sure what the current status is."/> 
      <min value="1"/> 
      <max value="1"/> 
      <type> 
        <code value="code"/> 
      </type> 
      <isModifier value="true"/> 
      <isSummary value="true"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="EventStatus"/> 
        </extension> 
        <strength value="required"/> 
        <description value="Codes identifying the stage lifecycle stage of a event"/> 
        <valueSetReference> 
          <reference value="http://hl7.org/fhir/ValueSet/event-status"/> 
        </valueSetReference> 
      </binding> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".status"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="status"/> 
      </mapping> 
    </element> 
    <element id="Event.notDone">
      <path value="Event.notDone"/> 
      <short value="{{title}} did not occur"/> 
      <definition value="If true, indicates that the described event (combination of code, timing, performer, etc.)
       did not actually occur."/> 
      <comment value="The more attributes are populated, the more constrained the negated statement is.  For
       example if timeframe and performer are specified, that means the event wasn't done by
       that performer in that time-period, but could well have been done by someone else or by
       that performer in a different time period."/> 
      <requirements value="Creating a {{title}} where notDone is true is intended for situations where there's a
       need for a specific statement in the record about something not being done.  If the need
       is merely to indicate that a request wasn't fulfilled, that should be handled using Task."/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="boolean"/> 
      </type> 
      <isModifier value="true"/> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".actionNegationInd"/> 
      </mapping> 
    </element> 
    <element id="Event.notDoneReason">
      <path value="Event.notDoneReason"/> 
      <short value="Why {{title}} did not occur"/> 
      <definition value="Describes why the event did not occur in coded and/or textual form."/> 
      <requirements value="This is a separate element to allow it to have a distinct binding from reasonCode."/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <condition value="inv-1"/> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".reasonCode"/> 
      </mapping> 
    </element> 
    <element id="Event.code">
      <path value="Event.code"/> 
      <short value="What was done"/> 
      <definition value="A code that identifies the specific service or action that was or is being performed."/> 
      <alias value="type"/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <isSummary value="true"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="EventCode"/> 
        </extension> 
        <strength value="example"/> 
        <description value="Codes indicating the details of what is/was done.  These will vary significantly based
         on the type of request resource and will often be example/preferred rather than extensible/required."/> 
      </binding> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".code"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="what"/> 
      </mapping> 
    </element> 
    <element id="Event.subject">
      <path value="Event.subject"/> 
      <short value="Individual service was done for/to"/> 
      <definition value="The individual or set of individuals the action is being or was performed on."/> 
      <comment value="[For resources that aren't patient-specific, the set of allowed resources may be extended
       to include other things.  Group should generally be retained unless there's certainty
       this resource won't be used for veterinary, research or public health settings where Group
       may be necessary (e.g. this cage of rats/crate of chickens, group of people in a 5 mile
       radious of the incident, etc.)]."/> 
      <requirements value="Links the event to the Patient context."/> 
      <alias value="patient"/> 
      <min value="1"/> 
      <max value="1"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="PAT in proximity to EVN segment"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".participation[typeCode=SBJ].role"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="who.focus"/> 
      </mapping> 
    </element> 
    <element id="Event.context">
      <path value="Event.context"/> 
      <short value="Encounter / Episode associated with event"/> 
      <definition value="The encounter or episode of care that establishes the context for this event."/> 
      <comment value="This will typically be the encounter the event occurred within, but some events may be
       initiated prior to or after the official completion of an encounter or episode but still
       be tied to the context of the encounter or episode (e.g. pre-admission lab tests)."/> 
      <requirements value="Links the request to the Encounter context."/> 
      <alias value="encounter"/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="PV1 in proximity to EVN segment"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".inboundRelationship(typeCode=COMP].source[classCode&lt;=PCPR, moodCode=EVN]"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="context"/> 
      </mapping> 
    </element> 
    <element id="Event.occurrence[x]">
      <path value="Event.occurrence[x]"/> 
      <short value="When event occurred"/> 
      <definition value="The date or time(s) the activity occurred."/> 
      <comment value="[The list of types may be constrained as appropriate for the type of event]."/> 
      <alias value="timing"/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="dateTime"/> 
      </type> 
      <type> 
        <code value="Period"/> 
      </type> 
      <type> 
        <code value="Timing"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".effectiveTime"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="when.done"/> 
      </mapping> 
    </element> 
    <element id="Event.performer">
      <path value="Event.performer"/> 
      <short value="Who performed event"/> 
      <definition value="Indicates who or what performed the event."/> 
      <comment value="[Resources may choose to replace this with just a single performer or repeating where
       there's no need to distinguish role and/or responsible organization]."/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="Element"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="EVN.5 or by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"/> 
      </mapping> 
    </element> 
    <element id="Event.performer.role">
      <path value="Event.performer.role"/> 
      <short value="What type of performance was done"/> 
      <definition value="Describes the type of performance (e.g. primary surgeon, anaesthesiologiest, etc.)."/> 
      <comment value="[Adjust vocabulary to be appropriate to your domain - generally should reflect what the
       performer does, not who they are]."/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <isSummary value="true"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="EventPerformerRole"/> 
        </extension> 
        <strength value="example"/> 
        <description value="Codes describing the types of functional roles performers can take on when performing
         events"/> 
        <valueSetReference> 
          <reference value="http://hl7.org/fhir/ValueSet/performer-role"/> 
        </valueSetReference> 
      </binding> 
      <mapping> 
        <identity value="v2"/> 
        <map value="Varies by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".participation.functionCode"/> 
      </mapping> 
    </element> 
    <element id="Event.performer.actor">
      <path value="Event.performer.actor"/> 
      <short value="Individual who was performing"/> 
      <definition value="The device, practitioner, etc. who performed the action."/> 
      <min value="1"/> 
      <max value="1"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="EVN.5 or by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".player"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="who.actor"/> 
      </mapping> 
    </element> 
    <element id="Event.performer.onBehalfOf">
      <path value="Event.performer.onBehalfOf"/> 
      <short value="Organization organization was acting for"/> 
      <definition value="The organization the device or practitioner was acting on behalf of."/> 
      <requirements value="Practitioners and Devices can be associated with multiple organizations.  This element
       indicates which organization they were acting on behalf of when performing the action."/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> 
      </type> 
      <mapping> 
        <identity value="v2"/> 
        <map value="N/A"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".scoper"/> 
      </mapping> 
    </element> 
    <element id="Event.reasonCode">
      <path value="Event.reasonCode"/> 
      <short value="Why was event performed?"/> 
      <definition value="Describes why the event occurred in coded or textual form."/> 
      <comment value="Textual reasons can be captured using reasonCode.text."/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <isSummary value="true"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="EventReason"/> 
        </extension> 
        <strength value="example"/> 
        <description value="Codes identifying why this event was necessary.  These may be clinical reasons (e.g. diagnoses,
         symptoms) and/or administrative reasons.  While the detailed constraints of relevant reasons
         will vary by resource, some degree of consistency across resources around recommended
         codes would be desirable."/> 
      </binding> 
      <mapping> 
        <identity value="v2"/> 
        <map value="EVN.4 or by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".reasonCode"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="why"/> 
      </mapping> 
    </element> 
    <element id="Event.reasonReference">
      <path value="Event.reasonReference"/> 
      <short value="Why was event performed?"/> 
      <definition value="Indicates another resource whose existence justifies this event."/> 
      <comment value="[Additional resources may be added as appropriate]."/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> 
      </type> 
      <isSummary value="true"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="EVN.4 or by domain"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".outboundRelationship[typeCode=RSON].target"/> 
      </mapping> 
      <mapping> 
        <identity value="w5"/> 
        <map value="why"/> 
      </mapping> 
    </element> 
    <element id="Event.note">
      <path value="Event.note"/> 
      <short value="Comments made about the event"/> 
      <definition value="Comments made about the event by the performer, subject or other participants."/> 
      <min value="0"/> 
      <max value="*"/> 
      <type> 
        <code value="Annotation"/> 
      </type> 
      <mapping> 
        <identity value="v2"/> 
        <map value="NTE"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"/> 
      </mapping> 
    </element> 
  </snapshot> 
</StructureDefinition>