This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Clinical Decision Support ![]() | Maturity Level: 0 | Trial Use | Security Category: Anonymous | Compartments: No defined compartments |
The EventDefinition resource provides a reusable description of when a particular event can occur.
This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.
The EventDefinition provides a reusable description of an event. The resource supports describing different kinds of events, including named events, periodic events, and data-based events. For each of these, the resource also supports a formal description of the event. For example, a 'monitor-emergency-admissions' event can be a named event, but also provide a formal description of the event as monitoring for encounters that occur in emergency department locations.
Implementation Note: The EventDefinition resource is a candidate for removal from the specification. The resource was proposed prior to the development of the current subscriptions approach and the functionality it supports has been replaced by the SubscriptionTopic resource. We are seeking feedback on whether there would be any gaps left open by removing the EventDefinition in favor of making use of the SubscriptionTopic resource.
The EventDefinition resource is intended to be used to provide a reusable description of events for use by other resources that require event definition, such as Subscription. EventDefinition is a definition of an event that could occur, whereas Subscription is asking for notification of events when they occur.
Structure
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
TU | DomainResource | A description of when an event can occur Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
![]() ![]() ![]() |
ΣC | 0..1 | uri | Canonical identifier for this event definition, represented as a URI (globally unique) Warning: URL should not contain | or # - these characters make processing canonical references problematic |
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the event definition |
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the event definition |
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this event definition (computer friendly) |
![]() ![]() ![]() |
ΣT | 0..1 | string | Name for this event definition (human friendly) |
![]() ![]() ![]() |
0..1 | string | Subordinate title of the event definition | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
0..1 | Type of individual the event definition is focused on Binding: Participant Resource Types (Extensible) | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Group) | |||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed |
![]() ![]() ![]() |
ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher |
![]() ![]() ![]() |
T | 0..1 | markdown | Natural language description of the event definition |
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() ![]() |
ΣXD | 0..* | CodeableConcept | Intended jurisdiction for event definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
![]() ![]() ![]() |
T | 0..1 | markdown | Why this event definition is defined |
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the event definition | |
![]() ![]() ![]() |
T | 0..1 | markdown | Use and/or publishing restrictions |
![]() ![]() ![]() |
T | 0..1 | string | Copyright holder and year(s) |
![]() ![]() ![]() |
Σ | 0..1 | date | When the event definition was approved by publisher |
![]() ![]() ![]() |
Σ | 0..1 | date | When the event definition was last reviewed by the publisher |
![]() ![]() ![]() |
Σ | 0..1 | Period | When the event definition is expected to be used |
![]() ![]() ![]() |
XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc | |
![]() ![]() ![]() |
Σ | 1..* | TriggerDefinition | "when" the event occurs (multiple = 'or') |
![]() ![]() |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<EventDefinition xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this event definition, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the event definition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the event definition --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this event definition (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this event definition (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the event definition --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the event definition is focused on --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the event definition --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for event definition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this event definition is defined --> <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the event definition --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the event definition was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the event definition was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the event definition is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <trigger><!-- 1..* TriggerDefinition "when" the event occurs (multiple = 'or') --></trigger> </EventDefinition>
JSON Template
{"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 // versionAlgorithm[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", "versionAlgorithmCoding" : { Coding }, "name" : "<string>", // I 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/steward (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" : "<markdown>", // Describes the clinical usage of the event definition "copyright" : "<markdown>", // Use and/or publishing restrictions "copyrightLabel" : "<string>", // Copyright holder and year(s) "approvalDate" : "<date>", // When the event definition was approved by publisher "lastReviewDate" : "<date>", // When the event definition was last reviewed by the publisher "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') }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:EventDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this event definition, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the event definition fhir:version [ string ] ; # 0..1 Business version of the event definition # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:string ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this event definition (computer friendly) fhir:title [ string ] ; # 0..1 Name for this event definition (human friendly) fhir:subtitle [ string ] ; # 0..1 Subordinate title of the event definition fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage # subject[x] : 0..1 Type of individual the event definition is focused on. One of these 2 fhir:subject [ a fhir:CodeableConcept ; CodeableConcept ] fhir:subject [ a fhir:Reference ; Reference(Group) ] fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the event definition fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for event definition (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this event definition is defined fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the event definition fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the event definition was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the event definition was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the event definition is expected to be used fhir:topic ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the content fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc fhir:trigger ( [ TriggerDefinition ] ... ) ; # 1..* "when" the event occurs (multiple = 'or') ]
Changes from both R4 and R4B
EventDefinition | |
EventDefinition.versionAlgorithm[x] |
|
EventDefinition.subject[x] |
|
EventDefinition.usage |
|
EventDefinition.copyrightLabel |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Structure
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
TU | DomainResource | A description of when an event can occur Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
![]() ![]() ![]() |
ΣC | 0..1 | uri | Canonical identifier for this event definition, represented as a URI (globally unique) Warning: URL should not contain | or # - these characters make processing canonical references problematic |
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the event definition |
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the event definition |
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this event definition (computer friendly) |
![]() ![]() ![]() |
ΣT | 0..1 | string | Name for this event definition (human friendly) |
![]() ![]() ![]() |
0..1 | string | Subordinate title of the event definition | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() |
0..1 | Type of individual the event definition is focused on Binding: Participant Resource Types (Extensible) | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Group) | |||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed |
![]() ![]() ![]() |
ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher |
![]() ![]() ![]() |
T | 0..1 | markdown | Natural language description of the event definition |
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() ![]() |
ΣXD | 0..* | CodeableConcept | Intended jurisdiction for event definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
![]() ![]() ![]() |
T | 0..1 | markdown | Why this event definition is defined |
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the event definition | |
![]() ![]() ![]() |
T | 0..1 | markdown | Use and/or publishing restrictions |
![]() ![]() ![]() |
T | 0..1 | string | Copyright holder and year(s) |
![]() ![]() ![]() |
Σ | 0..1 | date | When the event definition was approved by publisher |
![]() ![]() ![]() |
Σ | 0..1 | date | When the event definition was last reviewed by the publisher |
![]() ![]() ![]() |
Σ | 0..1 | Period | When the event definition is expected to be used |
![]() ![]() ![]() |
XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc | |
![]() ![]() ![]() |
Σ | 1..* | TriggerDefinition | "when" the event occurs (multiple = 'or') |
![]() ![]() |
See the Extensions for this resource
XML Template
<EventDefinition xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this event definition, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the event definition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the event definition --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this event definition (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this event definition (human friendly) --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the event definition --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the event definition is focused on --></subject[x]> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the event definition --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for event definition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this event definition is defined --> <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the event definition --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the event definition was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the event definition was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the event definition is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <trigger><!-- 1..* TriggerDefinition "when" the event occurs (multiple = 'or') --></trigger> </EventDefinition>
JSON Template
{"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 // versionAlgorithm[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", "versionAlgorithmCoding" : { Coding }, "name" : "<string>", // I 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/steward (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" : "<markdown>", // Describes the clinical usage of the event definition "copyright" : "<markdown>", // Use and/or publishing restrictions "copyrightLabel" : "<string>", // Copyright holder and year(s) "approvalDate" : "<date>", // When the event definition was approved by publisher "lastReviewDate" : "<date>", // When the event definition was last reviewed by the publisher "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') }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:EventDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this event definition, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the event definition fhir:version [ string ] ; # 0..1 Business version of the event definition # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:string ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this event definition (computer friendly) fhir:title [ string ] ; # 0..1 Name for this event definition (human friendly) fhir:subtitle [ string ] ; # 0..1 Subordinate title of the event definition fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage # subject[x] : 0..1 Type of individual the event definition is focused on. One of these 2 fhir:subject [ a fhir:CodeableConcept ; CodeableConcept ] fhir:subject [ a fhir:Reference ; Reference(Group) ] fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the event definition fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for event definition (if applicable) fhir:purpose [ markdown ] ; # 0..1 Why this event definition is defined fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the event definition fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the event definition was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the event definition was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the event definition is expected to be used fhir:topic ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the content fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc fhir:trigger ( [ TriggerDefinition ] ... ) ; # 1..* "when" the event occurs (multiple = 'or') ]
Changes from both R4 and R4B
EventDefinition | |
EventDefinition.versionAlgorithm[x] |
|
EventDefinition.subject[x] |
|
EventDefinition.usage |
|
EventDefinition.copyrightLabel |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Additional definitions: Master Definition XML JSON, XML Schema/Schematron JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis
Path | ValueSet | Type | Documentation |
---|---|---|---|
EventDefinition.versionAlgorithm[x] | VersionAlgorithm | Extensible | Indicates the mechanism used to compare versions to determine which is more current. |
EventDefinition.status | PublicationStatus | Required | The lifecycle status of an artifact. |
EventDefinition.subject[x] | ParticipantResourceTypes | Extensible | All Resource Types that represent participant resources |
EventDefinition.jurisdiction | JurisdictionValueSet | Extensible | This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used. Note: The codes for countries and country subdivisions are taken from ISO 3166 |
EventDefinition.topic | DefinitionTopic | Example | High-level categorization of the definition, used for searching, sorting, and filtering. |
UniqueKey | Level | Location | Description | Expression |
![]() | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') |
![]() | Warning | EventDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic | exists() implies matches('^[^|# ] $') |
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
composed-of | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='composed-of').resource (Any) |
6 Resources |
context | token | A use context assigned to the event definition | (EventDefinition.useContext.value.ofType(CodeableConcept)) | 30 Resources |
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)) | 30 Resources |
context-type | token | A type of use context assigned to the event definition | EventDefinition.useContext.code | 30 Resources |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the event definition | On EventDefinition.useContext: context-type: code context-quantity: value.ofType(Quantity) | value.ofType(Range) |
30 Resources |
context-type-value | composite | A use context type and value assigned to the event definition | On EventDefinition.useContext: context-type: code context: value.ofType(CodeableConcept) |
30 Resources |
date | date | The event definition publication date | EventDefinition.date | 30 Resources |
depends-on | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='depends-on').resource (Any) |
6 Resources |
derived-from | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='derived-from').resource (Any) |
10 Resources |
description | string | The description of the event definition | EventDefinition.description | 28 Resources |
effective | date | The time during which the event definition is intended to be in use | EventDefinition.effectivePeriod | 12 Resources |
identifier | token | External identifier for the event definition | EventDefinition.identifier | 36 Resources |
jurisdiction | token | Intended jurisdiction for the event definition | EventDefinition.jurisdiction | 26 Resources |
name | string | Computationally friendly name of the event definition | EventDefinition.name | 27 Resources |
predecessor | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='predecessor').resource (Any) |
10 Resources |
publisher | string | Name of the publisher of the event definition | EventDefinition.publisher | 30 Resources |
status | token | The current status of the event definition | EventDefinition.status | 36 Resources |
successor | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='successor').resource (Any) |
6 Resources |
title | string | The human-friendly name of the event definition | EventDefinition.title | 27 Resources |
topic | token | Topics associated with the module | EventDefinition.topic | 10 Resources |
url | uri | The uri that identifies the event definition | EventDefinition.url | 35 Resources |
version | token | The business version of the event definition | EventDefinition.version | 31 Resources |