Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 Content Examples Detailed Descriptions Mappings Profiles & Extensions 14.8.6 Resource EventDefinition - Detailed Descriptions R3

Example MessageDefinition/patient-link-notification (JSON)

Clinical Decision Support Infrastructure And Messaging Work Group Maturity Level : 0   Trial Use N/A Security Category Standards Status : Anonymous Informative Compartments : Not linked to any defined compartments
Detailed Descriptions for the elements in the EventDefinition resource. EventDefinition Element Id EventDefinition Definition The EventDefinition resource provides a reusable description of when a particular event can occur. Cardinality 0..* Type DomainResource Invariants Defined on this element evd-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}') EventDefinition.url Element Id EventDefinition.url Definition An 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. Cardinality 0..1 Type uri Requirements Allows the event definition to be referenced by a single globally unique identifier. Summary true Comments Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions . In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. EventDefinition.identifier Element Id EventDefinition.identifier Definition A 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.
    Note
  • This is a business identifier, not a resource identifier (see discussion Narrative )
  • Cardinality XML 0..*
  • Type JSON
  • Identifier TTL Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module. Summary Raw JSON true Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this event definition outside of FHIR, where it is not possible to use the logical URI. ( canonical form EventDefinition.version Element Id EventDefinition.version Definition The 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. Note This is a business versionId, not a resource version id (see discussion see JSON Format Specification ) Cardinality 0..1 Type string Summary true Comments There may be different event definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the event definition with the format [url]|[version]. EventDefinition.name Element Id EventDefinition.name Definition A 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. Cardinality 0..1 Type string Requirements Support human navigation and code generation. Summary true Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. Invariants Affect this element inv-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}') EventDefinition.title Element Id EventDefinition.title Definition A short, descriptive, user-friendly title for the event definition. Cardinality 0..1 Type string Summary true Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

EventDefinition.subtitle Element Id EventDefinition.subtitle Definition

An explanatory or alternate title for the event definition giving additional information about its content. Cardinality 0..1 Type string EventDefinition.status Element Id EventDefinition.status Definition The status of this event definition. Enables tracking the life-cycle of the content. Cardinality 1..1 Terminology Binding PublicationStatus ( Required ) Type code Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) Summary true Comments Allows filtering of event definitions that are appropriate for use versus not. EventDefinition.experimental Element Id EventDefinition.experimental Definition A 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. Cardinality 0..1 Type boolean Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level event definition. Summary true Comments Allows filtering of event definitions that are appropriate for use versus not. EventDefinition.subject[x] Element Id EventDefinition.subject[x] Definition A code or group definition that describes the intended subject of the event definition. Cardinality 0..1 Terminology Binding Subject type ( Extensible ) Type CodeableConcept | Reference ( Group ) [x] Note See Choice of Data Types for further information about how to use [x] Meaning if Missing Patient EventDefinition.date Element Id EventDefinition.date Definition The 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. Cardinality 0..1 Type dateTime Alternate Names Revision Date Summary true Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the event definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. EventDefinition.publisher Element Id EventDefinition.publisher Definition The name of the organization or individual that published the event definition. Cardinality 0..1 Type string Requirements Helps establish the "authority/credibility" of the event definition. May also allow for contact. Summary true Comments Usually an organization but may be an individual. The publisher (or steward) of the event definition is the organization or individual primarily responsible for the maintenance and upkeep of the event definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the event definition. This item SHOULD be populated unless the information is available from context. EventDefinition.contact Element Id EventDefinition.contact Definition Contact details to assist a user in finding and communicating with the publisher. Cardinality 0..* Type ContactDetail Summary true Comments May be a web site, an email address, a telephone number, etc. EventDefinition.description Element Id EventDefinition.description Definition A free text natural language description example of the event definition from a consumer's perspective. Cardinality 0..1 Type markdown Comments This description can be used to capture details such as why the event definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the event definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the event definition is presumed to be the predominant language in the place the event definition was created). EventDefinition.useContext Element Id EventDefinition.useContext Definition The 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. Cardinality 0..* Type UsageContext Requirements Assist in searching for appropriate content. Summary true Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. EventDefinition.jurisdiction Element Id EventDefinition.jurisdiction Definition A legal or geographic region in which the event definition is intended to be used. Cardinality 0..* Terminology Binding Jurisdiction ( Extensible ) Type CodeableConcept Summary true Comments It may be possible for the event definition to be used in jurisdictions other than those for which it was originally designed or intended. patient link notification

EventDefinition.purpose Element Id EventDefinition.purpose Definition 
{
  "resourceType": "MessageDefinition",
  "id": "patient-link-notification",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Link Patients Notification</div>"
  },
  "url": "http://hl7.org/fhir/MessageDefinition/patient-link-notification",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.15.2"
    }
  ],
  "version": "1",
  "name": "PATIENT-LINK-NOTIFICATION",
  "title": "Link Patients Notification",
  "status": "draft",
  "experimental": true,
  "date": "2017-02-03",
  "publisher": "Health Level Seven, Int'l",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org"
        }
      ]
    }
  ],
  "description": "Notification of two patient records that represent the same individual that require an established linkage.",
  "useContext": [
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/variant-state",
            "code": "positive"
          }
        ]
      }
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America (the)"
        }
      ]
    }
  ],
  "purpose": "Notifies recipient systems that two patients have been 'linked' - meaning they represent the same individual",
  "copyright": "� HL7.org 2011+",
  "base": "http://hl7.org/fhir/MessageDefinition/example",
  "eventCoding": {
    "system": "http://example.org/fhir/message-events",
    "code": "admin-notify"
  },
  "category": "notification",
  "focus": [
    {
      "code": "Patient",
      "profile": "http://hl7.org/fhir/StructureDefinition/example",
      "min": 2,
      "max": "2"
    }
  ],
  "allowedResponse": [
    {
      "message": "http://hl7.org/fhir/MessageDefinition/patient-link-response",
      "situation": "Optional response message that may provide additional information"
    }
  ]
}

Explanation of why this event definition is needed and why it Usage note: every effort has been designed as it has. Cardinality 0..1 Type markdown Comments This element does not describe the usage of the event definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point made to source materials or specifications ensure that drove the structure of this event definition. EventDefinition.usage Element Id EventDefinition.usage Definition A detailed description of how the event definition is used from a clinical perspective. Cardinality 0..1 Type string To Do Does this apply? EventDefinition.copyright Element Id EventDefinition.copyright Definition A copyright statement relating to the event definition and/or its contents. Copyright statements examples are generally legal restrictions on the use correct and publishing of the event definition. Cardinality 0..1 Type markdown Requirements Consumers must be able to determine any legal restrictions on the use of the event definition and/or its content. Alternate Names License; Restrictions EventDefinition.approvalDate Element Id EventDefinition.approvalDate Definition The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. Cardinality 0..1 Type date Summary true Comments The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. EventDefinition.lastReviewDate Element Id EventDefinition.lastReviewDate Definition The date on which the resource content was last reviewed. Review happens periodically after approval useful, but does not change the original approval date. Cardinality 0..1 Type date Requirements Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. Summary true Comments If specified, this date follows the original approval date. EventDefinition.effectivePeriod Element Id EventDefinition.effectivePeriod Definition The period during which the event definition content was or is planned to be in active use. Cardinality 0..1 Type Period Requirements Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the event definition are or they are expected to be used instead. Summary true Comments The effective period for a event definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. EventDefinition.topic Element Id EventDefinition.topic Definition Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching. Cardinality 0..* Terminology Binding DefinitionTopic ( Example ) Type CodeableConcept Requirements Repositories must be able to determine how to categorize the module so that it can be found by topical searches. To Do Does this apply? EventDefinition.author Element Id EventDefinition.author Definition An individiual or organization primarily involved in the creation and maintenance of the content. Cardinality 0..* Type ContactDetail To Do Does this apply? EventDefinition.editor Element Id EventDefinition.editor Definition An individual or organization primarily responsible for internal coherence of the content. Cardinality 0..* Type ContactDetail To Do Does this apply? EventDefinition.reviewer Element Id EventDefinition.reviewer Definition An individual or organization primarily responsible for review of some aspect of the content. Cardinality 0..* Type ContactDetail To Do Does this apply? EventDefinition.endorser Element Id EventDefinition.endorser Definition An individual or organization responsible for officially endorsing the content for use in some setting. Cardinality 0..* Type ContactDetail To Do Does this apply? EventDefinition.relatedArtifact Element Id EventDefinition.relatedArtifact Definition Related resources such as additional documentation, justification, or bibliographic references. Cardinality 0..* Type RelatedArtifact Requirements Modules must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. Comments Each related resource is either an attachment, or a reference to another resource, but not both. To Do Does this apply? EventDefinition.trigger Element Id EventDefinition.trigger Definition The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one a normative part of the trigger conditions is met. specification.

Cardinality 1..* Type TriggerDefinition Summary true