Skip to main content

EventDefinition

Draft Specialized — Quality & Testing

The EventDefinition resource provides a reusable description of when a particular event can occur.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/EventDefinition
InteractionMethodPath
ReadGET/fhir/R4/EventDefinition/[id]
VreadGET/fhir/R4/EventDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R4/EventDefinition/[id]
PatchPATCH/fhir/R4/EventDefinition/[id]
DeleteDELETE/fhir/R4/EventDefinition/[id]
CreatePOST/fhir/R4/EventDefinition
SearchGET/fhir/R4/EventDefinition
HistoryGET/fhir/R4/EventDefinition/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
urluri0..1Canonical identifier for this event definition, represented as a URI (globally unique)
identifierIdentifier0..*Additional identifier for the event definition
versionstring0..1Business version of the event definition
namestring0..1Name for this event definition (computer friendly)
titlestring0..1Name for this event definition (human friendly)
subtitlestring0..1Subordinate title of the event definition
statuscode1..1draft | active | retired | unknown modifier
experimentalboolean0..1For testing purposes, not real usage
subject[x]CodeableConcept / Reference0..1Type of individual the event definition is focused on
datedateTime0..1Date last changed
publisherstring0..1Name of the publisher (organization or individual)
contactContactDetail0..*Contact details for the publisher
descriptionmarkdown0..1Natural language description of the event definition
useContextUsageContext0..*The context that the content is intended to support
jurisdictionCodeableConcept0..*Intended jurisdiction for event definition (if applicable)
purposemarkdown0..1Why this event definition is defined
usagestring0..1Describes the clinical usage of the event definition
copyrightmarkdown0..1Use and/or publishing restrictions
approvalDatedate0..1When the event definition was approved by publisher
lastReviewDatedate0..1When the event definition was last reviewed
effectivePeriodPeriod0..1When the event definition is expected to be used
topicCodeableConcept0..*E.g. Education, Treatment, Assessment, etc.
authorContactDetail0..*Who authored the content
editorContactDetail0..*Who edited the content
reviewerContactDetail0..*Who reviewed the content
endorserContactDetail0..*Who endorsed the content
relatedArtifactRelatedArtifact0..*Additional documentation, citations, etc.
triggerTriggerDefinition1..*"when" the event occurs (multiple = 'or')

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
composed-ofstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-composed-of
contextstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-context
context-quantitystringhttp://hl7.org/fhir/SearchParameter/EventDefinition-context-quantity
context-typestringhttp://hl7.org/fhir/SearchParameter/EventDefinition-context-type
context-type-quantitystringhttp://hl7.org/fhir/SearchParameter/EventDefinition-context-type-quantity
context-type-valuestringhttp://hl7.org/fhir/SearchParameter/EventDefinition-context-type-value
datestringhttp://hl7.org/fhir/SearchParameter/EventDefinition-date
depends-onstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-depends-on
derived-fromstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-derived-from
descriptionstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-description
effectivestringhttp://hl7.org/fhir/SearchParameter/EventDefinition-effective
identifierstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-identifier
jurisdictionstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-jurisdiction
namestringhttp://hl7.org/fhir/SearchParameter/EventDefinition-name
predecessorstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-predecessor
publisherstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-publisher
statusstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-status
successorstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-successor
titlestringhttp://hl7.org/fhir/SearchParameter/EventDefinition-title
topicstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-topic
urlstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-url
versionstringhttp://hl7.org/fhir/SearchParameter/EventDefinition-version

Reference​