R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

Event.json

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: Informative

Raw JSON (canonical form)

Logical Model Event

{
  "resourceType": "StructureDefinition",
  "id": "Event",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">to do</div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "Informative"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/Event",
  "name": "Event",
  "title": "event",
  "status": "draft",
  "date": "2018-04-03T12:05:46+10:00",
  "publisher": "Health Level Seven International fhir",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "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": "3.3.0",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "snapshot": {
    "element": [
      {
        "id": "Event",
        "path": "Event",
        "short": "Event Pattern",
        "definition": "A pattern to be followed by resources that represent the performance of some activity, possibly in accordance with a request or service definition.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "inv-2",
            "severity": "error",
            "human": "reason elements can only be specified if status is NOT 'not-done'",
            "expression": "status!='not-done' or (reasonCode.exists().not() and reasonReference.exists().not())",
            "xpath": "not(f:status/@value='not-done') or not(exists(f:reasonCode) or exists(f:reasonReference))"
          },
          {
            "key": "inv-1",
            "severity": "error",
            "human": "Not Done Reason can only be specified if status is 'not-done'",
            "expression": "status='not-done' or notDoneReason.exists().not()",
            "xpath": "f:status/@value='not-done' or not(exists(f:notDoneReason))"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN (for administrative events)"
          },
          {
            "identity": "rim",
            "map": "Act[moodCode=EVN]"
          }
        ]
      },
      {
        "id": "Event.identifier",
        "path": "Event.identifier",
        "short": "Business Identifier for {{title}}",
        "definition": "Business identifiers assigned to this {{title}} by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
        "comment": "Note: This is a business identifer, not a resource identifier (see [discussion](resource.html#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": "Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.identifier",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".identifier"
          },
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "Event.instantiatesCanonical",
        "path": "Event.instantiatesCanonical",
        "short": "Instantiates FHIR protocol or definition",
        "definition": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.instantiatesCanonical",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "canonical",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Definition"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=DEFN].target"
          }
        ]
      },
      {
        "id": "Event.instantiatesUri",
        "path": "Event.instantiatesUri",
        "short": "Instantiates external protocol or definition",
        "definition": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.",
        "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.instantiatesUri",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=DEFN].target"
          }
        ]
      },
      {
        "id": "Event.basedOn",
        "path": "Event.basedOn",
        "short": "Fulfills plan, proposal or order",
        "definition": "A plan, proposal or order that is fulfilled in whole or in part by this {{title}}.",
        "comment": "[The allowed reference resources may be adjusted as appropriate for the event resource].",
        "requirements": "Allows tracing of authorization for the {{title}} and tracking whether proposals/recommendations were acted upon.",
        "alias": [
          "fulfills"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.basedOn",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Request"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "ORC in proximity to EVN segment"
          },
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=FLFS].target"
          }
        ]
      },
      {
        "id": "Event.partOf",
        "path": "Event.partOf",
        "short": "Part of referenced event",
        "definition": "A larger event of which this particular {{title}} is a component or step.",
        "comment": "Not to be used to link an {{title}} to an Encounter - use 'context' for that.\n\n[The allowed reference resources may be adjusted as appropriate for the event resource].",
        "requirements": "[E.g. Drug administration as part of a procedure, procedure as part of observation, etc.].",
        "alias": [
          "container"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.partOf",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Event"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
          }
        ]
      },
      {
        "id": "Event.status",
        "path": "Event.status",
        "short": "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown",
        "definition": "The current state of the {{title}}.",
        "comment": "A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation\n\nUnknown 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": 1,
        "max": "1",
        "base": {
          "path": "Event.status",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isModifierReason": "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": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EventStatus"
            }
          ],
          "strength": "required",
          "description": "Codes identifying the lifecycle stage of a event",
          "valueSetCanonical": "http://hl7.org/fhir/ValueSet/event-status"
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".status"
          },
          {
            "identity": "w5",
            "map": "FiveWs.status"
          }
        ]
      },
      {
        "id": "Event.statusReason",
        "path": "Event.statusReason",
        "short": "Reason for current status",
        "definition": "Captures the reason for the current state of the {{title}}.",
        "comment": "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.\n\n[distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].",
        "alias": [
          "Suspended Reason",
          "Cancelled Reason"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Event.statusReason",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EventStatusReason"
            }
          ],
          "strength": "example",
          "description": "Codes identifying the reason for the current state of an event"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
          }
        ]
      },
      {
        "id": "Event.code",
        "path": "Event.code",
        "short": "What was done",
        "definition": "A code that identifies the specific service or action that was or is being performed.",
        "alias": [
          "type"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Event.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EventCode"
            }
          ],
          "strength": "example",
          "description": "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."
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".code"
          },
          {
            "identity": "w5",
            "map": "FiveWs.what[x]"
          }
        ]
      },
      {
        "id": "Event.subject",
        "path": "Event.subject",
        "short": "Individual service was done for/to",
        "definition": "The individual or set of individuals the action is being or was performed on.",
        "comment": "[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": "Links the {{title}} to the Patient context.",
        "alias": [
          "patient"
        ],
        "min": 1,
        "max": "1",
        "base": {
          "path": "Event.subject",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/Group"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "PAT in proximity to EVN segment"
          },
          {
            "identity": "rim",
            "map": ".participation[typeCode=SBJ].role"
          },
          {
            "identity": "w5",
            "map": "FiveWs.subject"
          }
        ]
      },
      {
        "id": "Event.context",
        "path": "Event.context",
        "short": "Associated Encounter / Episode",
        "definition": "The encounter or episode of care that establishes the context for this {{title}}.",
        "comment": "This will typically be the encounter the {{title}} occurred within, but some {{title}}s 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": "Links the {{title}} to the Encounter context.",
        "alias": [
          "encounter"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Event.context",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Encounter",
              "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "PV1 in proximity to EVN segment"
          },
          {
            "identity": "rim",
            "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
          },
          {
            "identity": "w5",
            "map": "FiveWs.context"
          }
        ]
      },
      {
        "id": "Event.occurrence[x]",
        "path": "Event.occurrence[x]",
        "short": "When {{title}} occurred/is occurring",
        "definition": "The date, period or timing when the {{title}} did occur or is occurring.",
        "comment": "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.\n\n[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": [
          "timing"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Event.occurrence[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          },
          {
            "code": "Period"
          },
          {
            "code": "Timing"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".effectiveTime"
          },
          {
            "identity": "w5",
            "map": "FiveWs.done[x]"
          }
        ]
      },
      {
        "id": "Event.performer",
        "path": "Event.performer",
        "short": "Who performed {{title}} and what they did",
        "definition": "Indicates who or what performed the {{title}} and how they were involved.",
        "comment": "[Resources may choose to replace this with just a single performer or repeating where there's no need to distinguish the function performed].",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.performer",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Element"
          }
        ],
        "isModifier": false,
        "isSummary": true
      },
      {
        "id": "Event.performer.function",
        "path": "Event.performer.function",
        "short": "Type of performance",
        "definition": "Distinguishes the type of involvement of the performer in the {{title}}. [Consider adding examples].",
        "requirements": "Allows disambiguation of the types of involvement of different performers.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Event.performer.function",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EventPerformerFunction"
            }
          ],
          "strength": "example",
          "description": "Codes that describe the specific involvement of a performer in an event.  E.g. Primary vs. secondary vs. supervising, etc."
        }
      },
      {
        "id": "Event.performer.actor",
        "path": "Event.performer.actor",
        "short": "Who performed {{title}}",
        "definition": "Indicates who or what performed the {{title}}.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Event.performer.actor",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Organization",
              "http://hl7.org/fhir/StructureDefinition/CareTeam",
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/Device",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN.5 or by domain"
          },
          {
            "identity": "rim",
            "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
          },
          {
            "identity": "w5",
            "map": "FiveWs.actor"
          }
        ]
      },
      {
        "id": "Event.location",
        "path": "Event.location",
        "short": "Where {{title}} occurred",
        "definition": "The principal physical location where the {{title}} was performed.",
        "requirements": "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": 0,
        "max": "1",
        "base": {
          "path": "Event.location",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Location"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN.7"
          },
          {
            "identity": "rim",
            "map": ".participation[typeCode=LOC].role"
          },
          {
            "identity": "w5",
            "map": "FiveWs.where[x]"
          }
        ]
      },
      {
        "id": "Event.reasonCode",
        "path": "Event.reasonCode",
        "short": "Why was {{title}} performed?",
        "definition": "Describes why the {{title}} occurred in coded or textual form.",
        "comment": "Textual reasons can be captured using reasonCode.text.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.reasonCode",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EventReason"
            }
          ],
          "strength": "example",
          "description": "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."
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN.4 or by domain"
          },
          {
            "identity": "rim",
            "map": ".reasonCode"
          },
          {
            "identity": "w5",
            "map": "FiveWs.why[x]"
          }
        ]
      },
      {
        "id": "Event.reasonReference",
        "path": "Event.reasonReference",
        "short": "Why was {{title}} performed?",
        "definition": "Indicates another resource whose existence justifies this {{title}}.",
        "comment": "[Additional resources may be added as appropriate].",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.reasonReference",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Condition",
              "http://hl7.org/fhir/StructureDefinition/Observation",
              "http://hl7.org/fhir/StructureDefinition/Media",
              "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
              "http://hl7.org/fhir/StructureDefinition/DocumentReference"
            ]
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN.4 or by domain"
          },
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=RSON].target"
          },
          {
            "identity": "w5",
            "map": "FiveWs.why[x]"
          }
        ]
      },
      {
        "id": "Event.note",
        "path": "Event.note",
        "short": "Comments made about the event",
        "definition": "Comments made about the {{title}} by the performer, subject or other participants.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Event.note",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Annotation"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "v2",
            "map": "NTE"
          },
          {
            "identity": "rim",
            "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
          }
        ]
      }
    ]
  }
}

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.