Package org.hl7.fhir.r5.model

Class SubscriptionTopic

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.CanonicalResource
org.hl7.fhir.r5.model.SubscriptionTopic
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 SubscriptionTopic extends CanonicalResource
Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
See Also:

  • Field Details

    • url

      protected UriType url
      An absolute URI that is used to identify this subscription topic 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 an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers.

    • identifier

      protected List<Identifier> identifier
      Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

    • version

      protected StringType version
      The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic 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 are orderable.

    • versionAlgorithm

      protected DataType versionAlgorithm
      Indicates the mechanism used to compare versions to determine which is more current.

    • name

      protected StringType name
      A natural language name identifying the subscription topic This name should be usable as an identifier for the module by machine processing applications such as code generation.

    • title

      protected StringType title
      A short, descriptive, user-friendly title for the subscription topic. For example, "admission".

    • derivedFrom

      protected List<CanonicalType> derivedFrom
      The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.

    • status

      protected Enumeration<Enumerations.PublicationStatus> status
      The current state of the SubscriptionTopic.

    • experimental

      protected BooleanType experimental
      A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • date

      protected DateTimeType date
      The date (and optionally time) when the subscription topic was last significantly changed. 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 subscription topic changes.

    • publisher

      protected StringType publisher
      Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.

    • contact

      protected List<ContactDetail> contact
      Contact details to assist a user in finding and communicating with the publisher.

    • description

      protected MarkdownType description
      A free text natural language description of the Topic from the consumer's perspective.

    • useContext

      protected List<UsageContext> useContext
      The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

    • jurisdiction

      protected List<CodeableConcept> jurisdiction
      A jurisdiction in which the Topic is intended to be used.

    • purpose

      protected MarkdownType purpose
      Explains why this Topic is needed and why it has been designed as it has.

    • copyrightLabel

      protected StringType copyrightLabel
      A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

    • approvalDate

      protected DateType approvalDate
      The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

    • lastReviewDate

      protected DateType lastReviewDate
      The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

    • effectivePeriod

      protected Period effectivePeriod
      The period during which the SubscriptionTopic content was or is planned to be effective.

    • resourceTrigger

      protected List<SubscriptionTopic.SubscriptionTopicResourceTriggerComponent> resourceTrigger
      A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

    • eventTrigger

      protected List<SubscriptionTopic.SubscriptionTopicEventTriggerComponent> eventTrigger
      Event definition which can be used to trigger the SubscriptionTopic.

    • canFilterBy

      protected List<SubscriptionTopic.SubscriptionTopicCanFilterByComponent> canFilterBy
      List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).

    • notificationShape

      protected List<SubscriptionTopic.SubscriptionTopicNotificationShapeComponent> notificationShape
      List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The activity definition publication date [ActorDefinition](actordefinition.html): The Actor Definition publication date [CapabilityStatement](capabilitystatement.html): The capability statement publication date [ChargeItemDefinition](chargeitemdefinition.html): The charge item definition publication date [Citation](citation.html): The citation publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [ConditionDefinition](conditiondefinition.html): The condition definition publication date [EventDefinition](eventdefinition.html): The event definition publication date [Evidence](evidence.html): The evidence publication date [EvidenceVariable](evidencevariable.html): The evidence variable publication date [ExampleScenario](examplescenario.html): The example scenario publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [Library](library.html): The library publication date [Measure](measure.html): The measure publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [PlanDefinition](plandefinition.html): The plan definition publication date [Questionnaire](questionnaire.html): The questionnaire publication date [Requirements](requirements.html): The requirements publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [SubscriptionTopic](subscriptiontopic.html): Date status first applied [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [TestScript](testscript.html): The test script publication date [ValueSet](valueset.html): The value set publication date
      Type: date
      Path: ActivityDefinition.date | ActorDefinition.date | CapabilityStatement.date | ChargeItemDefinition.date | Citation.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | ConditionDefinition.date | EventDefinition.date | Evidence.date | EvidenceVariable.date | ExampleScenario.date | GraphDefinition.date | ImplementationGuide.date | Library.date | Measure.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | PlanDefinition.date | Questionnaire.date | Requirements.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | SubscriptionTopic.date | TerminologyCapabilities.date | TestScript.date | ValueSet.date

      See Also:

    • DATE

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The activity definition publication date [ActorDefinition](actordefinition.html): The Actor Definition publication date [CapabilityStatement](capabilitystatement.html): The capability statement publication date [ChargeItemDefinition](chargeitemdefinition.html): The charge item definition publication date [Citation](citation.html): The citation publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [ConditionDefinition](conditiondefinition.html): The condition definition publication date [EventDefinition](eventdefinition.html): The event definition publication date [Evidence](evidence.html): The evidence publication date [EvidenceVariable](evidencevariable.html): The evidence variable publication date [ExampleScenario](examplescenario.html): The example scenario publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [Library](library.html): The library publication date [Measure](measure.html): The measure publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [PlanDefinition](plandefinition.html): The plan definition publication date [Questionnaire](questionnaire.html): The questionnaire publication date [Requirements](requirements.html): The requirements publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [SubscriptionTopic](subscriptiontopic.html): Date status first applied [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [TestScript](testscript.html): The test script publication date [ValueSet](valueset.html): The value set publication date
      Type: date
      Path: ActivityDefinition.date | ActorDefinition.date | CapabilityStatement.date | ChargeItemDefinition.date | Citation.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | ConditionDefinition.date | EventDefinition.date | Evidence.date | EvidenceVariable.date | ExampleScenario.date | GraphDefinition.date | ImplementationGuide.date | Library.date | Measure.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | PlanDefinition.date | Questionnaire.date | Requirements.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | SubscriptionTopic.date | TerminologyCapabilities.date | TestScript.date | ValueSet.date

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
      Type: token
      Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier

      See Also:

    • IDENTIFIER

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
      Type: token
      Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
      Type: token
      Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status

      See Also:

    • STATUS

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
      Type: token
      Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status

    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition [Citation](citation.html): The human-friendly name of the citation [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition [EventDefinition](eventdefinition.html): The human-friendly name of the event definition [Evidence](evidence.html): The human-friendly name of the evidence [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [Library](library.html): The human-friendly name of the library [Measure](measure.html): The human-friendly name of the measure [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire [Requirements](requirements.html): The human-friendly name of the requirements [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly) [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [TestScript](testscript.html): The human-friendly name of the test script [ValueSet](valueset.html): The human-friendly name of the value set
      Type: string
      Path: ActivityDefinition.title | ActorDefinition.title | CapabilityStatement.title | ChargeItemDefinition.title | Citation.title | CodeSystem.title | ConceptMap.title | ConditionDefinition.title | EventDefinition.title | Evidence.title | EvidenceVariable.title | ImplementationGuide.title | Library.title | Measure.title | MessageDefinition.title | ObservationDefinition.title | OperationDefinition.title | PlanDefinition.title | Questionnaire.title | Requirements.title | SpecimenDefinition.title | StructureDefinition.title | StructureMap.title | SubscriptionTopic.title | TerminologyCapabilities.title | TestScript.title | ValueSet.title

      See Also:

    • TITLE

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition [Citation](citation.html): The human-friendly name of the citation [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition [EventDefinition](eventdefinition.html): The human-friendly name of the event definition [Evidence](evidence.html): The human-friendly name of the evidence [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [Library](library.html): The human-friendly name of the library [Measure](measure.html): The human-friendly name of the measure [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire [Requirements](requirements.html): The human-friendly name of the requirements [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly) [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [TestScript](testscript.html): The human-friendly name of the test script [ValueSet](valueset.html): The human-friendly name of the value set
      Type: string
      Path: ActivityDefinition.title | ActorDefinition.title | CapabilityStatement.title | ChargeItemDefinition.title | Citation.title | CodeSystem.title | ConceptMap.title | ConditionDefinition.title | EventDefinition.title | Evidence.title | EvidenceVariable.title | ImplementationGuide.title | Library.title | Measure.title | MessageDefinition.title | ObservationDefinition.title | OperationDefinition.title | PlanDefinition.title | Questionnaire.title | Requirements.title | SpecimenDefinition.title | StructureDefinition.title | StructureMap.title | SubscriptionTopic.title | TerminologyCapabilities.title | TestScript.title | ValueSet.title

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition [Citation](citation.html): The uri that identifies the citation [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The URI that identifies the concept map [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition [EventDefinition](eventdefinition.html): The uri that identifies the event definition [Evidence](evidence.html): The uri that identifies the evidence [EvidenceReport](evidencereport.html): The uri that identifies the evidence report [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable [ExampleScenario](examplescenario.html): The uri that identifies the example scenario [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [Library](library.html): The uri that identifies the library [Measure](measure.html): The uri that identifies the measure [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [PlanDefinition](plandefinition.html): The uri that identifies the plan definition [Questionnaire](questionnaire.html): The uri that identifies the questionnaire [Requirements](requirements.html): The uri that identifies the requirements [SearchParameter](searchparameter.html): The uri that identifies the search parameter [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique) [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [TestPlan](testplan.html): The uri that identifies the test plan [TestScript](testscript.html): The uri that identifies the test script [ValueSet](valueset.html): The uri that identifies the value set
      Type: uri
      Path: ActivityDefinition.url | ActorDefinition.url | CapabilityStatement.url | ChargeItemDefinition.url | Citation.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | ConditionDefinition.url | EventDefinition.url | Evidence.url | EvidenceReport.url | EvidenceVariable.url | ExampleScenario.url | GraphDefinition.url | ImplementationGuide.url | Library.url | Measure.url | MessageDefinition.url | NamingSystem.url | ObservationDefinition.url | OperationDefinition.url | PlanDefinition.url | Questionnaire.url | Requirements.url | SearchParameter.url | SpecimenDefinition.url | StructureDefinition.url | StructureMap.url | SubscriptionTopic.url | TerminologyCapabilities.url | TestPlan.url | TestScript.url | ValueSet.url

      See Also:

    • URL

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition [Citation](citation.html): The uri that identifies the citation [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The URI that identifies the concept map [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition [EventDefinition](eventdefinition.html): The uri that identifies the event definition [Evidence](evidence.html): The uri that identifies the evidence [EvidenceReport](evidencereport.html): The uri that identifies the evidence report [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable [ExampleScenario](examplescenario.html): The uri that identifies the example scenario [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [Library](library.html): The uri that identifies the library [Measure](measure.html): The uri that identifies the measure [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [PlanDefinition](plandefinition.html): The uri that identifies the plan definition [Questionnaire](questionnaire.html): The uri that identifies the questionnaire [Requirements](requirements.html): The uri that identifies the requirements [SearchParameter](searchparameter.html): The uri that identifies the search parameter [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique) [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [TestPlan](testplan.html): The uri that identifies the test plan [TestScript](testscript.html): The uri that identifies the test script [ValueSet](valueset.html): The uri that identifies the value set
      Type: uri
      Path: ActivityDefinition.url | ActorDefinition.url | CapabilityStatement.url | ChargeItemDefinition.url | Citation.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | ConditionDefinition.url | EventDefinition.url | Evidence.url | EvidenceReport.url | EvidenceVariable.url | ExampleScenario.url | GraphDefinition.url | ImplementationGuide.url | Library.url | Measure.url | MessageDefinition.url | NamingSystem.url | ObservationDefinition.url | OperationDefinition.url | PlanDefinition.url | Questionnaire.url | Requirements.url | SearchParameter.url | SpecimenDefinition.url | StructureDefinition.url | StructureMap.url | SubscriptionTopic.url | TerminologyCapabilities.url | TestPlan.url | TestScript.url | ValueSet.url

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The business version of the activity definition [ActorDefinition](actordefinition.html): The business version of the Actor Definition [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The business version of the charge item definition [Citation](citation.html): The business version of the citation [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [ConditionDefinition](conditiondefinition.html): The business version of the condition definition [EventDefinition](eventdefinition.html): The business version of the event definition [Evidence](evidence.html): The business version of the evidence [EvidenceVariable](evidencevariable.html): The business version of the evidence variable [ExampleScenario](examplescenario.html): The business version of the example scenario [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [Library](library.html): The business version of the library [Measure](measure.html): The business version of the measure [MessageDefinition](messagedefinition.html): The business version of the message definition [NamingSystem](namingsystem.html): The business version of the naming system [OperationDefinition](operationdefinition.html): The business version of the operation definition [PlanDefinition](plandefinition.html): The business version of the plan definition [Questionnaire](questionnaire.html): The business version of the questionnaire [Requirements](requirements.html): The business version of the requirements [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [SubscriptionTopic](subscriptiontopic.html): Business version of the SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [TestScript](testscript.html): The business version of the test script [ValueSet](valueset.html): The business version of the value set
      Type: token
      Path: ActivityDefinition.version | ActorDefinition.version | CapabilityStatement.version | ChargeItemDefinition.version | Citation.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | ConditionDefinition.version | EventDefinition.version | Evidence.version | EvidenceVariable.version | ExampleScenario.version | GraphDefinition.version | ImplementationGuide.version | Library.version | Measure.version | MessageDefinition.version | NamingSystem.version | OperationDefinition.version | PlanDefinition.version | Questionnaire.version | Requirements.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | SubscriptionTopic.version | TerminologyCapabilities.version | TestScript.version | ValueSet.version

      See Also:

    • VERSION

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The business version of the activity definition [ActorDefinition](actordefinition.html): The business version of the Actor Definition [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The business version of the charge item definition [Citation](citation.html): The business version of the citation [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [ConditionDefinition](conditiondefinition.html): The business version of the condition definition [EventDefinition](eventdefinition.html): The business version of the event definition [Evidence](evidence.html): The business version of the evidence [EvidenceVariable](evidencevariable.html): The business version of the evidence variable [ExampleScenario](examplescenario.html): The business version of the example scenario [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [Library](library.html): The business version of the library [Measure](measure.html): The business version of the measure [MessageDefinition](messagedefinition.html): The business version of the message definition [NamingSystem](namingsystem.html): The business version of the naming system [OperationDefinition](operationdefinition.html): The business version of the operation definition [PlanDefinition](plandefinition.html): The business version of the plan definition [Questionnaire](questionnaire.html): The business version of the questionnaire [Requirements](requirements.html): The business version of the requirements [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [SubscriptionTopic](subscriptiontopic.html): Business version of the SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [TestScript](testscript.html): The business version of the test script [ValueSet](valueset.html): The business version of the value set
      Type: token
      Path: ActivityDefinition.version | ActorDefinition.version | CapabilityStatement.version | ChargeItemDefinition.version | Citation.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | ConditionDefinition.version | EventDefinition.version | Evidence.version | EvidenceVariable.version | ExampleScenario.version | GraphDefinition.version | ImplementationGuide.version | Library.version | Measure.version | MessageDefinition.version | NamingSystem.version | OperationDefinition.version | PlanDefinition.version | Questionnaire.version | Requirements.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | SubscriptionTopic.version | TerminologyCapabilities.version | TestScript.version | ValueSet.version

    • SP_DERIVED_OR_SELF

      public static final String SP_DERIVED_OR_SELF
      Search parameter: derived-or-self

      Description: A server defined search that matches either the url or derivedFrom
      Type: uri
      Path: SubscriptionTopic.url | SubscriptionTopic.derivedFrom

      See Also:

    • DERIVED_OR_SELF

      public static final ca.uhn.fhir.rest.gclient.UriClientParam DERIVED_OR_SELF
      Fluent Client search parameter constant for derived-or-self

      Description: A server defined search that matches either the url or derivedFrom
      Type: uri
      Path: SubscriptionTopic.url | SubscriptionTopic.derivedFrom

    • SP_EFFECTIVE

      public static final String SP_EFFECTIVE
      Search parameter: effective

      Description: Effective period
      Type: date
      Path: SubscriptionTopic.effectivePeriod

      See Also:

    • EFFECTIVE

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

      Description: Effective period
      Type: date
      Path: SubscriptionTopic.effectivePeriod

    • SP_EVENT

      public static final String SP_EVENT
      Search parameter: event

      Description: Event trigger
      Type: token
      Path: SubscriptionTopic.eventTrigger.event

      See Also:

    • EVENT

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

      Description: Event trigger
      Type: token
      Path: SubscriptionTopic.eventTrigger.event

    • SP_RESOURCE

      public static final String SP_RESOURCE
      Search parameter: resource

      Description: Allowed resource for this definition
      Type: uri
      Path: SubscriptionTopic.resourceTrigger.resource | SubscriptionTopic.eventTrigger.resource | SubscriptionTopic.canFilterBy.resource | SubscriptionTopic.notificationShape.resource

      See Also:

    • RESOURCE

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

      Description: Allowed resource for this definition
      Type: uri
      Path: SubscriptionTopic.resourceTrigger.resource | SubscriptionTopic.eventTrigger.resource | SubscriptionTopic.canFilterBy.resource | SubscriptionTopic.notificationShape.resource

    • SP_TRIGGER_DESCRIPTION

      public static final String SP_TRIGGER_DESCRIPTION
      Search parameter: trigger-description

      Description: Text representation of the trigger
      Type: string
      Path: SubscriptionTopic.resourceTrigger.description

      See Also:

    • TRIGGER_DESCRIPTION

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

      Description: Text representation of the trigger
      Type: string
      Path: SubscriptionTopic.resourceTrigger.description

  • Constructor Details

  • Method Details