This page is part of the FHIR Specification (v3.0.2: STU 3). 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
Detailed Descriptions for the elements in the event resource.
Event | |
Definition | A pattern to be followed by resources that represent the performance of some activity, possibly in accordance with a request or service definition. |
Control | 1..1 |
Invariants | Defined on this element inv-1: Not Done Reason can only be specified if NotDone is "true" (expression : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason))) |
Event.identifier | |
Definition | Identifiers assigned to this event performer or other systems. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows identification of the event as it is known by various participating systems and in a way that remains consistent across servers. |
Summary | true |
Event.definition | |
Definition | A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event. |
Control | 0..* |
Type | Reference(Definition) |
Summary | true |
Comments | [The allowed reference resources may be adjusted as appropriate for the event resource]. |
Event.basedOn | |
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. |
Control | 0..* |
Type | Reference(Request) |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Alternate Names | fulfills |
Summary | true |
Comments | [The allowed reference resources may be adjusted as appropriate for the event resource]. |
Event.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Control | 0..* |
Type | Reference(Event) |
Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. |
Alternate Names | container |
Summary | true |
Comments | 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]. |
Event.status | |
Definition | The current state of the event. |
Control | 1..1 |
Terminology Binding | EventStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | 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. |
To Do | Should this be a common code system for all events? |
Event.notDone | |
Definition | If true, indicates that the described event (combination of code, timing, performer, etc.) did not actually occur. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | 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. |
Summary | true |
Comments | 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. |
Event.notDoneReason | |
Definition | Describes why the event did not occur in coded and/or textual form. |
Control | 0..1 |
Type | CodeableConcept |
Requirements | This is a separate element to allow it to have a distinct binding from reasonCode. |
Summary | true |
Invariants | Affect this element inv-1: Not Done Reason can only be specified if NotDone is "true" (expression : notDone or notDoneReason.exists().not(), xpath: f:notDone/@value=true() or not(exists(f:notDoneReason))) |
Event.code | |
Definition | A code that identifies the specific service or action that was or is being performed. |
Control | 0..1 |
Terminology Binding | EventCode: |
Type | CodeableConcept |
Alternate Names | type |
Summary | true |
Event.subject | |
Definition | The individual or set of individuals the action is being or was performed on. |
Control | 1..1 |
Type | Reference(Patient | Group) |
Requirements | Links the event to the Patient context. |
Alternate Names | patient |
Summary | true |
Comments | [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.)]. |
To Do | For mapping, is it better if we make this Any and then constrain it down? |
Event.context | |
Definition | The encounter or episode of care that establishes the context for this event. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Requirements | Links the request to the Encounter context. |
Alternate Names | encounter |
Summary | true |
Comments | 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). |
Event.occurrence[x] | |
Definition | The date or time(s) the activity occurred. |
Control | 0..1 |
Type | dateTime|Period|Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | timing |
Summary | true |
Comments | [The list of types may be constrained as appropriate for the type of event]. |
Event.performer | |
Definition | Indicates who or what performed the event. |
Control | 0..* |
Summary | true |
Comments | [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]. |
Event.performer.role | |
Definition | Describes the type of performance (e.g. primary surgeon, anaesthesiologiest, etc.). |
Control | 0..1 |
Terminology Binding | Procedure Performer Role Codes (Example) |
Type | CodeableConcept |
Summary | true |
Comments | [Adjust vocabulary to be appropriate to your domain - generally should reflect what the performer does, not who they are]. |
Event.performer.actor | |
Definition | The device, practitioner, etc. who performed the action. |
Control | 1..1 |
Type | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) |
Summary | true |
Event.performer.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of. |
Control | 0..1 |
Type | Reference(Organization) |
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action. |
Event.reasonCode | |
Definition | Describes why the event occurred in coded or textual form. |
Control | 0..* |
Terminology Binding | EventReason: |
Type | CodeableConcept |
Summary | true |
Comments | Textual reasons can be captured using reasonCode.text. |
Event.reasonReference | |
Definition | Indicates another resource whose existence justifies this event. |
Control | 0..* |
Type | Reference(Condition | Observation) |
Summary | true |
Comments | [Additional resources may be added as appropriate]. |
Event.note | |
Definition | Comments made about the event by the performer, subject or other participants. |
Control | 0..* |
Type | Annotation |