Class EventDefinition

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class EventDefinition extends MetadataResource
The EventDefinition resource provides a reusable description of when a particular event can occur.
See Also:
  • Field Details

    • identifier

      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.
    • subtitle

      protected StringType subtitle
      An explanatory or alternate title for the event definition giving additional information about its content.
    • subject

      protected Type subject
      A code or group definition that describes the intended subject of the event definition.
    • purpose

      protected MarkdownType purpose
      Explanation of why this event definition is needed and why it has been designed as it has.
    • usage

      protected StringType usage
      A detailed description of how the event definition is used from a clinical perspective.
    • approvalDate

      The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • lastReviewDate

      The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • effectivePeriod

      The period during which the event definition content was or is planned to be in active use.
    • topic

      Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
    • author

      An individiual or organization primarily involved in the creation and maintenance of the content.
    • editor

      An individual or organization primarily responsible for internal coherence of the content.
    • reviewer

      An individual or organization primarily responsible for review of some aspect of the content.
    • endorser

      An individual or organization responsible for officially endorsing the content for use in some setting.
    • relatedArtifact

      Related resources such as additional documentation, justification, or bibliographic references.
    • trigger

      The 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.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The event definition publication date
      Type: date
      Path: EventDefinition.date

      See Also:
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: The event definition publication date
      Type: date
      Path: EventDefinition.date

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier for the event definition
      Type: token
      Path: EventDefinition.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: External identifier for the event definition
      Type: token
      Path: EventDefinition.identifier

    • SP_SUCCESSOR

      public static final String SP_SUCCESSOR
      Search parameter: successor

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

      See Also:
    • SUCCESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
      Fluent Client search parameter constant for successor

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

    • INCLUDE_SUCCESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "EventDefinition:successor".
    • SP_CONTEXT_TYPE_VALUE

      public static final String SP_CONTEXT_TYPE_VALUE
      Search parameter: context-type-value

      Description: A use context type and value assigned to the event definition
      Type: composite
      Path:

      See Also:
    • CONTEXT_TYPE_VALUE

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
      Fluent Client search parameter constant for context-type-value

      Description: A use context type and value assigned to the event definition
      Type: composite
      Path:

    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the event definition
      Type: token
      Path: EventDefinition.jurisdiction

      See Also:
    • JURISDICTION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
      Fluent Client search parameter constant for jurisdiction

      Description: Intended jurisdiction for the event definition
      Type: token
      Path: EventDefinition.jurisdiction

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the event definition
      Type: string
      Path: EventDefinition.description

      See Also:
    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: The description of the event definition
      Type: string
      Path: EventDefinition.description

    • SP_DERIVED_FROM

      public static final String SP_DERIVED_FROM
      Search parameter: derived-from

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

      See Also:
    • DERIVED_FROM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
      Fluent Client search parameter constant for derived-from

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

    • INCLUDE_DERIVED_FROM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "EventDefinition:derived-from".
    • SP_CONTEXT_TYPE

      public static final String SP_CONTEXT_TYPE
      Search parameter: context-type

      Description: A type of use context assigned to the event definition
      Type: token
      Path: EventDefinition.useContext.code

      See Also:
    • CONTEXT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
      Fluent Client search parameter constant for context-type

      Description: A type of use context assigned to the event definition
      Type: token
      Path: EventDefinition.useContext.code

    • SP_PREDECESSOR

      public static final String SP_PREDECESSOR
      Search parameter: predecessor

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

      See Also:
    • PREDECESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
      Fluent Client search parameter constant for predecessor

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

    • INCLUDE_PREDECESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "EventDefinition:predecessor".
    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the event definition
      Type: string
      Path: EventDefinition.title

      See Also:
    • TITLE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: The human-friendly name of the event definition
      Type: string
      Path: EventDefinition.title

    • SP_COMPOSED_OF

      public static final String SP_COMPOSED_OF
      Search parameter: composed-of

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

      See Also:
    • COMPOSED_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF
      Fluent Client search parameter constant for composed-of

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

    • INCLUDE_COMPOSED_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "EventDefinition:composed-of".
    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the event definition
      Type: token
      Path: EventDefinition.version

      See Also:
    • VERSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
      Fluent Client search parameter constant for version

      Description: The business version of the event definition
      Type: token
      Path: EventDefinition.version

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the event definition
      Type: uri
      Path: EventDefinition.url

      See Also:
    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the event definition
      Type: uri
      Path: EventDefinition.url

    • SP_CONTEXT_QUANTITY

      public static final String SP_CONTEXT_QUANTITY
      Search parameter: context-quantity

      Description: A quantity- or range-valued use context assigned to the event definition
      Type: quantity
      Path: EventDefinition.useContext.valueQuantity, EventDefinition.useContext.valueRange

      See Also:
    • CONTEXT_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
      Fluent Client search parameter constant for context-quantity

      Description: A quantity- or range-valued use context assigned to the event definition
      Type: quantity
      Path: EventDefinition.useContext.valueQuantity, EventDefinition.useContext.valueRange

    • SP_EFFECTIVE

      public static final String SP_EFFECTIVE
      Search parameter: effective

      Description: The time during which the event definition is intended to be in use
      Type: date
      Path: EventDefinition.effectivePeriod

      See Also:
    • EFFECTIVE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
      Fluent Client search parameter constant for effective

      Description: The time during which the event definition is intended to be in use
      Type: date
      Path: EventDefinition.effectivePeriod

    • SP_DEPENDS_ON

      public static final String SP_DEPENDS_ON
      Search parameter: depends-on

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

      See Also:
    • DEPENDS_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON
      Fluent Client search parameter constant for depends-on

      Description: What resource is being referenced
      Type: reference
      Path: EventDefinition.relatedArtifact.resource

    • INCLUDE_DEPENDS_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "EventDefinition:depends-on".
    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the event definition
      Type: string
      Path: EventDefinition.name

      See Also:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: Computationally friendly name of the event definition
      Type: string
      Path: EventDefinition.name

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the event definition
      Type: token
      Path: EventDefinition.useContext.valueCodeableConcept

      See Also:
    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: A use context assigned to the event definition
      Type: token
      Path: EventDefinition.useContext.valueCodeableConcept

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the event definition
      Type: string
      Path: EventDefinition.publisher

      See Also:
    • PUBLISHER

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
      Fluent Client search parameter constant for publisher

      Description: Name of the publisher of the event definition
      Type: string
      Path: EventDefinition.publisher

    • SP_TOPIC

      public static final String SP_TOPIC
      Search parameter: topic

      Description: Topics associated with the module
      Type: token
      Path: EventDefinition.topic

      See Also:
    • TOPIC

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC
      Fluent Client search parameter constant for topic

      Description: Topics associated with the module
      Type: token
      Path: EventDefinition.topic

    • SP_CONTEXT_TYPE_QUANTITY

      public static final String SP_CONTEXT_TYPE_QUANTITY
      Search parameter: context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the event definition
      Type: composite
      Path:

      See Also:
    • CONTEXT_TYPE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
      Fluent Client search parameter constant for context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the event definition
      Type: composite
      Path:

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the event definition
      Type: token
      Path: EventDefinition.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The current status of the event definition
      Type: token
      Path: EventDefinition.status

  • Constructor Details

  • Method Details