EventDefinition - FHIR Resource (r4)


This EventDefinition Resource uses the FHIR API standard for access and structure.

Validate an EventDefinition FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
approvalDatefalsedate# When the event definition was approved by publisher
authortrueContactDetail# Who authored the content
contacttrueContactDetail# Contact details for the publisher
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date last changed
descriptionfalsemarkdown# Natural language description of the event definition
editortrueContactDetail# Who edited the content
effectivePeriodfalsePeriod# When the event definition is expected to be used
endorsertrueContactDetail# Who endorsed the content
experimentalfalseboolean# For testing purposes, not real usage
identifiertrueIdentifier# Additional identifier for the event definition
jurisdictiontrueCodeableConcept# Intended jurisdiction for event definition (if applicable)
lastReviewDatefalsedate# When the event definition was last reviewed
namefalsestring# C? Name for this event definition (computer friendly)
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this event definition is defined
relatedArtifacttrueRelatedArtifact# Additional documentation, citations, etc.
reviewertrueContactDetail# Who reviewed the content
statusfalsecode# draft | active | retired | unknown
subject[x]falseReference#undefined
subtitlefalsestring# Subordinate title of the event definition
titlefalsestring# Name for this event definition (human friendly)
topictrueCodeableConcept# E.g. Education, Treatment, Assessment, etc.
triggertrueTriggerDefinition# "when" the event occurs (multiple = 'or')
urlfalseuri# Canonical identifier for this event definition, represented as a URI (globally unique)
usagefalsestring# Describes the clinical usage of the event definition
useContexttrueUsageContext# The context that the content is intended to support
versionfalsestring# Business version of the event definition

EventDefinition Example

{
  "resourceType": "EventDefinition",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n    </div>"
  },
  "status": "draft",
  "purpose": "Monitor all admissions to Emergency",
  "trigger": [
    {
      "type": "named-event",
      "name": "monitor-emergency-admissions",
      "data": [
        {
          "type": "Encounter"
        }
      ],
      "condition": {
        "description": "Encounter Location = emergency (active/completed encounters, current or previous)",
        "language": "text/fhirpath",
        "expression": "(this | %previous).location.where(location = 'Location/emergency' and status in {'active', 'completed'}).exists()"
      }
    }
  ]
}

EventDefinition Structure

{
  "resourceType" : "EventDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this event definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the event definition
  "version" : "<string>", // Business version of the event definition
  "name" : "<string>", // C? Name for this event definition (computer friendly)
  "title" : "<string>", // Name for this event definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the event definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the event definition is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the event definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for event definition (if applicable)
  "purpose" : "<markdown>", // Why this event definition is defined
  "usage" : "<string>", // Describes the clinical usage of the event definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the event definition was approved by publisher
  "lastReviewDate" : "<date>", // When the event definition was last reviewed
  "effectivePeriod" : { Period }, // When the event definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "trigger" : [{ TriggerDefinition }] // R!  "when" the event occurs (multiple = 'or')
}

EventDefinition Search Parameters

The following search parameters can be used to query EventDefinition resources. Just submit them like so:

https://api.1up.health/fhir/r4/EventDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
composed-ofreferencerelatedArtifact.where
contexttextuseContext.value
context-quantityquantityuseContext.value
context-typetextuseContext.code
context-type-quantitycompositeuseContext
context-type-valuecompositeuseContext
datedatedate
depends-onreferencerelatedArtifact.where
derived-fromreferencerelatedArtifact.where
descriptiontextdescription
effectivedateeffectivePeriod
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
predecessorreferencerelatedArtifact.where
publishertextpublisher
statustextstatus
successorreferencerelatedArtifact.where
titletexttitle
topictexttopic
urluriurl
versiontextversion