This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
Logical Model Event
<?xml version="1.0" encoding="UTF-8"?> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Event"/> <version value="5.0.0-ballot"/> <name value="Event"/> <title value="event"/> <status value="draft"/> <experimental value="false"/> <date value="2022-09-10T04:52:37+10: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="5.0.0-ballot"/> <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/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <kind value="logical"/> <abstract value="false"/> <type value="Event"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> <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="*"/> <base> <path value="Event"/> <min value="0"/> <max value="*"/> </base> <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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="inv-1"/> <severity value="error"/> <human value="Not Done Reason can only be specified if status is 'not-done'"/> <expression value="status='not-done' or notDoneReason.exists().not()"/> <xpath value="f:status/@value='not-done' or not(exists(f:notDoneReason))"/> <source value="http://hl7.org/fhir/StructureDefinition/Event"/> </constraint> <constraint> <key value="inv-2"/> <severity value="error"/> <human value="reason elements can only be specified if status is NOT 'not-done'"/> <expression value="status!='not-done' or (reasonCode.exists().not() and reasonReference.exists().not())"/> <xpath value="not(f:status/@value='not-done') or not(exists(f:reasonCode) or exists(f:reasonReference))"/> <source value="http://hl7.org/fhir/StructureDefinition/Event"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <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 {{title}}"/> <definition value="Business identifiers assigned to this {{title}} by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server."/> <comment value="Note: This is a business identifier, not a resource identifier (see [discussion](resource.htm l#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number."/> <requirements value="Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers."/> <min value="0"/> <max value="*"/> <base> <path value="Event.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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="FiveWs.identifier"/> </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 {{title}}."/> <comment value="[The allowed reference resources may be adjusted as appropriate for the event resource]."/> <requirements value="Allows tracing of authorization for the {{title}} and tracking whether proposals/recommendati ons were acted upon."/> <alias value="fulfills"/> <min value="0"/> <max value="*"/> <base> <path value="Event.basedOn"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Appointment"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/AppointmentResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CarePlan"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Claim"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CommunicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Contract"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionOrder"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RequestOrchestration"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SupplyRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/VisionPrescription"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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 {{title}} is a component or step."/> <comment value="Not to be used to link an {{title}} to an Encounter - use '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="*"/> <base> <path value="Event.partOf"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/AuditEvent"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ChargeItem"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ClaimResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ClinicalImpression"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Communication"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Composition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Consent"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Coverage"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DetectedIssue"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceUsage"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentManifest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EnrollmentResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/GuidanceResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImagingSelection"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImagingStudy"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Immunization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/InventoryReport"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationAdministration"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationDispense"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationUsage"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionIntake"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PaymentNotice"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Procedure"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Provenance"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RiskAssessment"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SupplyDelivery"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Transport"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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.researchStudy"> <path value="Event.researchStudy"/> <short value="Associated research study"/> <definition value="Indicates that this {{title}} is relevant to the specified research study(ies)."/> <comment value="This relevance might mean that the {{title}} occurred as part of the study protocol, but can also include events that occurred outside the study but still have relevance."/> <min value="0"/> <max value="*"/> <base> <path value="Event.researchStudy"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ResearchStudy"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="Varies by domain"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=PERT].target[classCode=CLNTRL, moodCode=EVN]"/> </mapping> </element> <element id="Event.status"> <path value="Event.status"/> <short value="preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown"/> <definition value="The current state of the {{title}}."/> <comment value="A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation Unknown does not represent "other" - 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"/> <base> <path value="Event.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition"> <valueString value="Codes identifying the lifecycle stage of an event."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EventStatus"/> </extension> <strength value="required"/> <valueSet value="http://hl7.org/fhir/ValueSet/event-status|5.0.0-ballot"/> </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="FiveWs.status"/> </mapping> </element> <element id="Event.statusReason"> <path value="Event.statusReason"/> <short value="Reason for current status"/> <definition value="Captures the reason for the current state of the {{title}}."/> <comment value="This is generally only used for "exception" statuses such as "not-done", "suspended" or "cancelled". The reason for performing the event at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings]."/> <alias value="Suspended Reason"/> <alias value="Cancelled Reason"/> <min value="0"/> <max value="1"/> <base> <path value="Event.statusReason"/> <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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition"> <valueString value="Codes identifying the reason for the current state of an event."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EventStatusReason"/> </extension> <strength value="example"/> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"/> </mapping> </element> <element id="Event.category"> <path value="Event.category"/> <short value="High level categorization of {{title}}"/> <definition value="Partitions the {{title}} into one or more categories that can be used to filter searching, to govern access control and/or to guide system behavior."/> <comment value="Categorization might be done automatically (inferred by code) or manually by user assertion. The absence of a category may limit the ability to determine when the element should be handled, so strong consideration should be given to how systems will be able to determine category values for legacy data and how data that cannot be categorized will be handled. As well, some categories might not be mutually exclusive, so systems should prepare for multiple declared categories - even within a single category 'axis'. In general, there should not be a 'strong' binding ('required' or 'extensible') on the category element overall. Instead, the element can be sliced and bindings can be asserted that apply to particular repetitions."/> <min value="0"/> <max value="*"/> <base> <path value="Event.category"/> <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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Event.code"> <path value="Event.code"/> <short value="What service was done"/> <definition value="A code that identifies the specific service or action that was or is being performed."/> <comment value="[In some cases, the service type is implicit based on the scope of the resource and only a product element will be present]."/> <alias value="type"/> <min value="0"/> <max value="1"/> <base> <path value="Event.code"/> <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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition"> <valueString value="Codes indicating the details of what is/was done. These will vary significantly based on the type of event resource and will often be example/preferred rather than extensible/required."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EventCode"/> </extension> <strength value="example"/> </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="FiveWs.what[x]"/> </mapping> </element> <element id="Event.product"> <path value="Event.product"/> <short value="Product used/provided"/> <definition value="Indicates the product supplied or manipulated by this {{title}}."/> <min value="0"/> <max value="1"/> <base> <path value="Event.product"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableReference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Medication"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionProduct"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Substance"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Varies by domain"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRD].role"/> </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 {{title}} to the Patient context."/> <alias value="patient"/> <min value="1"/> <max value="1"/> <base> <path value="Event.subject"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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="FiveWs.subject"/> </mapping> </element> <element id="Event.encounter"> <path value="Event.encounter"/> <short value="Encounter the {{title}} is part of"/> <definition value="The Encounter during which this {{title}} was created or to which the creation of this record is tightly associated."/> <comment value="This will typically be the encounter the {{title}} was created during, but some {{title}}s may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests)."/> <requirements value="Links the {{title}} to the Encounter context."/> <alias value="context"/> <min value="0"/> <max value="1"/> <base> <path value="Event.encounter"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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<=PCPR, moodCode=EVN]"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> </element> <element id="Event.occurrence[x]"> <path value="Event.occurrence[x]"/> <short value="When {{title}} occurred/is occurring"/> <definition value="The date, period or timing when the {{title}} did occur or is occurring."/> <comment value="This indicates when the activity actually occurred or is occurring, not when it was asked/requested/ordered to occur. For the latter, look at the occurence element of the Request this {{event}} is "basedOn". The status code allows differentiation of whether the timing reflects a historic event or an ongoing event. Ongoing events should not include an upper bound in the Period or Timing.bounds. [The list of types may be constrained as appropriate for the type of event. The use of 'Timing' in type is generally only appropriate for Events that are typically used to represent summary information.]."/> <alias value="timing"/> <min value="0"/> <max value="1"/> <base> <path value="Event.occurrence[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <type> <code value="Timing"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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="FiveWs.done[x]"/> </mapping> </element> <element id="Event.recorded"> <path value="Event.recorded"/> <short value="When {{title}} was first captured in the subject's record"/> <definition value="The date the occurrence of the {{title}} was first captured in the record - potentially significantly after the occurrence of the event."/> <min value="0"/> <max value="1"/> <base> <path value="Event.recorded"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Varies by domain"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.recorded"/> </mapping> </element> <element id="Event.reported[x]"> <path value="Event.reported[x]"/> <short value="Reported rather than primary record"/> <definition value="Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report."/> <requirements value="Reported data may have different rules on editing and may be visually distinguished from primary data."/> <alias value="informer"/> <min value="0"/> <max value="1"/> <base> <path value="Event.reported[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=RPT].role"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.source"/> </mapping> </element> <element id="Event.performer"> <path value="Event.performer"/> <short value="Who performed {{title}} and what they did"/> <definition value="Indicates who or what performed the {{title}} and how they were involved."/> <comment value="[Resources may choose to replace this with just a single performer or repeating where there's no need to distinguish the function performed]."/> <min value="0"/> <max value="*"/> <base> <path value="Event.performer"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Element"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Event.performer.function"> <path value="Event.performer.function"/> <short value="Type of performance"/> <definition value="Distinguishes the type of involvement of the performer in the {{title}}. [Consider adding examples]."/> <requirements value="Allows disambiguation of the types of involvement of different performers."/> <min value="0"/> <max value="1"/> <base> <path value="Event.performer.function"/> <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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition"> <valueString value="Codes that describe the specific involvement of a performer in an event. E.g. Primary vs. secondary vs. supervising, etc."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EventPerformerFunction"/> </extension> <strength value="example"/> </binding> </element> <element id="Event.performer.actor"> <path value="Event.performer.actor"/> <short value="Who performed {{title}}"/> <definition value="Indicates who or what performed the {{title}}."/> <min value="1"/> <max value="1"/> <base> <path value="Event.performer.actor"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <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> <mapping> <identity value="w5"/> <map value="FiveWs.actor"/> </mapping> </element> <element id="Event.location"> <path value="Event.location"/> <short value="Where {{title}} occurred"/> <definition value="The principal physical location where the {{title}} was performed."/> <requirements value="Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting)."/> <min value="0"/> <max value="1"/> <base> <path value="Event.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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="EVN.7"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=LOC].role"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.where[x]"/> </mapping> </element> <element id="Event.reason"> <path value="Event.reason"/> <short value="Why was {{title}} performed?"/> <definition value="Describes why the {{title}} occurred in coded or textual form or Indicates another resource whose existence justifies this {{title}}."/> <comment value="Textual reasons can be captured using reasonCode.text."/> <min value="0"/> <max value="*"/> <base> <path value="Event.reason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableReference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition"> <valueString 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."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EventReason"/> </extension> <strength value="example"/> </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="FiveWs.why[x]"/> </mapping> </element> <element id="Event.note"> <path value="Event.note"/> <short value="Comments made about the event"/> <definition value="Comments made about the {{title}} by the performer, subject or other participants."/> <min value="0"/> <max value="*"/> <base> <path value="Event.note"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Annotation"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <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> <element id="Event.relevantHistory"> <path value="Event.relevantHistory"/> <short value="Key events in history of {{title}}"/> <definition value="Links to Provenance records for past versions of this resource or component resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource."/> <comment value="This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. Referenced provenances should adhere to the provenance-relevant-history profile. See additional guidance [here](event.html#history)."/> <alias value="eventHistory"/> <min value="0"/> <max value="*"/> <base> <path value="Event.relevantHistory"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </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="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"/> </mapping> </element> </snapshot> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 04:54+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change