EventDefinition

ResourceSpecialized · Definitional ArtifactsTrial useMaturity 0

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

15 of 22 parameters tested

Structure

Show inherited elements (8)

Element	Card.	Type	Description
urlΣ	0..1	uri	Canonical identifier for this event definition, represented as a URI (globally unique)
identifierΣ	0..*	Identifier	Additional identifier for the event definition
versionΣ	0..1	string	Business version of the event definition
nameΣ	0..1	string	Name for this event definition (computer friendly)
titleΣ	0..1	string	Name for this event definition (human friendly)
subtitle	0..1	string	Subordinate title of the event definition
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
subject[x]	0..1	CodeableConcept | Reference(Group)	Type of individual the event definition is focused onBinding (extensible): subject-type
dateΣ	0..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
description	0..1	markdown	Natural language description of the event definition
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for event definition (if applicable)Binding (extensible): jurisdiction
purpose	0..1	markdown	Why this event definition is defined
usage	0..1	string	Describes the clinical usage of the event definition
copyright	0..1	markdown	Use and/or publishing restrictions
approvalDateΣ	0..1	date	When the event definition was approved by publisher
lastReviewDateΣ	0..1	date	When the event definition was last reviewed
effectivePeriodΣ	0..1	Period	When the event definition is expected to be used
topic	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc.Binding (example): definition-topic
author	0..*	ContactDetail	Who authored the content
editor	0..*	ContactDetail	Who edited the content
reviewer	0..*	ContactDetail	Who reviewed the content
endorser	0..*	ContactDetail	Who endorsed the content
relatedArtifact	0..*	RelatedArtifact	Additional documentation, citations, etc.
triggerRequiredΣ	1..*	TriggerDefinition	"when" the event occurs (multiple = 'or')

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/EventDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
composed-of	reference	What resource is being referenced EventDefinition.relatedArtifact.where(type='composed-of').resource
context	token	A use context assigned to the event definition (EventDefinition.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the event definition (EventDefinition.useContext.value.ofType(Quantity)) | (EventDefinition.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the event definition EventDefinition.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the event definition EventDefinition.useContext
context-type-value	composite	A use context type and value assigned to the event definition EventDefinition.useContext
date	date	The event definition publication date EventDefinition.date
depends-on	reference	What resource is being referenced EventDefinition.relatedArtifact.where(type='depends-on').resource
derived-from	reference	What resource is being referenced EventDefinition.relatedArtifact.where(type='derived-from').resource
description	string	The description of the event definition EventDefinition.description
effective	date	The time during which the event definition is intended to be in use EventDefinition.effectivePeriod
identifier	token	External identifier for the event definition EventDefinition.identifier
jurisdiction	token	Intended jurisdiction for the event definition EventDefinition.jurisdiction
name	string	Computationally friendly name of the event definition EventDefinition.name
predecessor	reference	What resource is being referenced EventDefinition.relatedArtifact.where(type='predecessor').resource
publisher	string	Name of the publisher of the event definition EventDefinition.publisher
status	token	The current status of the event definition EventDefinition.status
successor	reference	What resource is being referenced EventDefinition.relatedArtifact.where(type='successor').resource
title	string	The human-friendly name of the event definition EventDefinition.title
topic	token	Topics associated with the module EventDefinition.topic
url	uri	The uri that identifies the event definition EventDefinition.url
version	token	The business version of the event definition EventDefinition.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition