Skip to main content

EventDefinition

PropertyValue
Publisher
NameEventDefinition
URLhttp://hl7.org/fhir/StructureDefinition/EventDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
EventDefinition0..*EventDefinitionThe EventDefinition resource provides a reusable description of when a particular event can occur.
EventDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
EventDefinition.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
EventDefinition.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
EventDefinition.language0..1codeThe base language in which the resource is written.
EventDefinition.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
EventDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
EventDefinition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
EventDefinition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
EventDefinition.url0..1uriAn absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.
EventDefinition.identifier0..*IdentifierA formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
EventDefinition.version0..1stringThe identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
EventDefinition.name0..1stringA natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
EventDefinition.title0..1stringA short, descriptive, user-friendly title for the event definition.
EventDefinition.subtitle0..1stringAn explanatory or alternate title for the event definition giving additional information about its content.
EventDefinition.status1..1codeThe status of this event definition. Enables tracking the life-cycle of the content.
EventDefinition.experimental0..1booleanA Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
EventDefinition.subject[x]0..1CodeableConceptA code or group definition that describes the intended subject of the event definition.
EventDefinition.date0..1dateTimeThe date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.
EventDefinition.publisher0..1stringThe name of the organization or individual that published the event definition.
EventDefinition.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
EventDefinition.description0..1markdownA free text natural language description of the event definition from a consumer's perspective.
EventDefinition.useContext0..*UsageContextThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
EventDefinition.jurisdiction0..*CodeableConceptA legal or geographic region in which the event definition is intended to be used.
EventDefinition.purpose0..1markdownExplanation of why this event definition is needed and why it has been designed as it has.
EventDefinition.usage0..1stringA detailed description of how the event definition is used from a clinical perspective.
EventDefinition.copyright0..1markdownA copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.
EventDefinition.approvalDate0..1dateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
EventDefinition.lastReviewDate0..1dateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
EventDefinition.effectivePeriod0..1PeriodThe period during which the event definition content was or is planned to be in active use.
EventDefinition.topic0..*CodeableConceptDescriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
EventDefinition.author0..*ContactDetailAn individiual or organization primarily involved in the creation and maintenance of the content.
EventDefinition.editor0..*ContactDetailAn individual or organization primarily responsible for internal coherence of the content.
EventDefinition.reviewer0..*ContactDetailAn individual or organization primarily responsible for review of some aspect of the content.
EventDefinition.endorser0..*ContactDetailAn individual or organization responsible for officially endorsing the content for use in some setting.
EventDefinition.relatedArtifact0..*RelatedArtifactRelated resources such as additional documentation, justification, or bibliographic references.
EventDefinition.trigger1..*TriggerDefinitionThe trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
composed-ofreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='composed-of').resource
contexttokenA use context assigned to the event definition(EventDefinition.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the event definition(EventDefinition.useContext.value.ofType(Quantity)) / (EventDefinition.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the event definitionEventDefinition.useContext.code
datedateThe event definition publication dateEventDefinition.date
depends-onreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='depends-on').resource
derived-fromreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='derived-from').resource
descriptionstringThe description of the event definitionEventDefinition.description
effectivedateThe time during which the event definition is intended to be in useEventDefinition.effectivePeriod
identifiertokenExternal identifier for the event definitionEventDefinition.identifier
jurisdictiontokenIntended jurisdiction for the event definitionEventDefinition.jurisdiction
namestringComputationally friendly name of the event definitionEventDefinition.name
predecessorreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='predecessor').resource
publisherstringName of the publisher of the event definitionEventDefinition.publisher
statustokenThe current status of the event definitionEventDefinition.status
successorreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='successor').resource
titlestringThe human-friendly name of the event definitionEventDefinition.title
topictokenTopics associated with the moduleEventDefinition.topic
urluriThe uri that identifies the event definitionEventDefinition.url
versiontokenThe business version of the event definitionEventDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the event definitionEventDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the event definitionEventDefinition.useContext