Event.json

Logical Model Event

{
  "resourceType": "StructureDefinition",
  "id": "Event",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">to do</div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Event",
  "name": "Event",
  "title": "event",
  "status": "draft",
  "date": "2019-10-24T11:53:00+11: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.0.2",
  "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/w5",
      "name": "W5 Mapping"
    }
  ],
  "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": "*",
        "constraint": [
          {
            "key": "inv-1",
            "severity": "error",
            "human": "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))"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN (for administrative events)"
          },
          {
            "identity": "rim",
            "map": "Act[moodCode=EVN]"
          }
        ]
      },
      {
        "id": "Event.identifier",
        "path": "Event.identifier",
        "short": "Business Identifier for event",
        "definition": "Identifiers assigned to this event performer or other systems.",
        "requirements": "Allows identification of the event as it is known by various participating systems and in a way that remains consistent across servers.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".identifier"
          },
          {
            "identity": "w5",
            "map": "id"
          }
        ]
      },
      {
        "id": "Event.definition",
        "path": "Event.definition",
        "short": "Instantiates protocol or definition",
        "definition": "A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.",
        "comment": "[The allowed reference resources may be adjusted as appropriate for the event resource].",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Definition"
          }
        ],
        "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 event.",
        "comment": "[The allowed reference resources may be adjusted as appropriate for the event resource].",
        "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
        "alias": [
          "fulfills"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Request"
          }
        ],
        "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 event is a component or step.",
        "comment": "Not to be used to link an event to an Encounter - use Event.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": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Event"
          }
        ],
        "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 | suspended | aborted | completed | entered-in-error | unknown",
        "definition": "The current state of the event.",
        "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",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EventStatus"
            }
          ],
          "strength": "required",
          "description": "Codes identifying the stage lifecycle stage of a event",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/event-status"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".status"
          },
          {
            "identity": "w5",
            "map": "status"
          }
        ]
      },
      {
        "id": "Event.notDone",
        "path": "Event.notDone",
        "short": "{{title}} did not occur",
        "definition": "If true, indicates that the described event (combination of code, timing, performer, etc.) did not actually occur.",
        "comment": "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": "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": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".actionNegationInd"
          }
        ]
      },
      {
        "id": "Event.notDoneReason",
        "path": "Event.notDoneReason",
        "short": "Why {{title}} did not occur",
        "definition": "Describes why the event did not occur in coded and/or textual form.",
        "requirements": "This is a separate element to allow it to have a distinct binding from reasonCode.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "condition": [
          "inv-1"
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".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",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "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": "what"
          }
        ]
      },
      {
        "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 event to the Patient context.",
        "alias": [
          "patient"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "PAT in proximity to EVN segment"
          },
          {
            "identity": "rim",
            "map": ".participation[typeCode=SBJ].role"
          },
          {
            "identity": "w5",
            "map": "who.focus"
          }
        ]
      },
      {
        "id": "Event.context",
        "path": "Event.context",
        "short": "Encounter / Episode associated with event",
        "definition": "The encounter or episode of care that establishes the context for this event.",
        "comment": "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": "Links the request to the Encounter context.",
        "alias": [
          "encounter"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
          }
        ],
        "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": "context"
          }
        ]
      },
      {
        "id": "Event.occurrence[x]",
        "path": "Event.occurrence[x]",
        "short": "When event occurred",
        "definition": "The date or time(s) the activity occurred.",
        "comment": "[The list of types may be constrained as appropriate for the type of event].",
        "alias": [
          "timing"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          },
          {
            "code": "Period"
          },
          {
            "code": "Timing"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".effectiveTime"
          },
          {
            "identity": "w5",
            "map": "when.done"
          }
        ]
      },
      {
        "id": "Event.performer",
        "path": "Event.performer",
        "short": "Who performed event",
        "definition": "Indicates who or what performed the event.",
        "comment": "[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": 0,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN.5 or by domain"
          },
          {
            "identity": "rim",
            "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
          }
        ]
      },
      {
        "id": "Event.performer.role",
        "path": "Event.performer.role",
        "short": "What type of performance was done",
        "definition": "Describes the type of performance (e.g. primary surgeon, anaesthesiologiest, etc.).",
        "comment": "[Adjust vocabulary to be appropriate to your domain - generally should reflect what the performer does, not who they are].",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "EventPerformerRole"
            }
          ],
          "strength": "example",
          "description": "Codes describing the types of functional roles performers can take on when performing events",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/performer-role"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "Varies by domain"
          },
          {
            "identity": "rim",
            "map": ".participation.functionCode"
          }
        ]
      },
      {
        "id": "Event.performer.actor",
        "path": "Event.performer.actor",
        "short": "Individual who was performing",
        "definition": "The device, practitioner, etc. who performed the action.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN.5 or by domain"
          },
          {
            "identity": "rim",
            "map": ".player"
          },
          {
            "identity": "w5",
            "map": "who.actor"
          }
        ]
      },
      {
        "id": "Event.performer.onBehalfOf",
        "path": "Event.performer.onBehalfOf",
        "short": "Organization organization was acting for",
        "definition": "The organization the device or practitioner was acting on behalf of.",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": ".scoper"
          }
        ]
      },
      {
        "id": "Event.reasonCode",
        "path": "Event.reasonCode",
        "short": "Why was event performed?",
        "definition": "Describes why the event occurred in coded or textual form.",
        "comment": "Textual reasons can be captured using reasonCode.text.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "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": "why"
          }
        ]
      },
      {
        "id": "Event.reasonReference",
        "path": "Event.reasonReference",
        "short": "Why was event performed?",
        "definition": "Indicates another resource whose existence justifies this event.",
        "comment": "[Additional resources may be added as appropriate].",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "EVN.4 or by domain"
          },
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=RSON].target"
          },
          {
            "identity": "w5",
            "map": "why"
          }
        ]
      },
      {
        "id": "Event.note",
        "path": "Event.note",
        "short": "Comments made about the event",
        "definition": "Comments made about the event by the performer, subject or other participants.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Annotation"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "NTE"
          },
          {
            "identity": "rim",
            "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
          }
        ]
      }
    ]
  }
}