Cmdlets for FHIR

Build 24.0.9062

SubscriptionTopic

SubscriptionTopic view.

Columns

Name Type Description
id String The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
lastUpdated Datetime The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules String A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language String The base language in which the resource is written.
text_div String The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
text_status String The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained String These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension String May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension String May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
url String An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
identifier_value String The value of the identifier. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
identifier_use String The identifier-use of the identifier-use. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
identifier_type_coding String The coding of the identifier-type. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
identifier_type_text String The text of the identifier-type. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
identifier_system String The identifier-system of the identifier-system. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
identifier_period_start String The start of the identifier-period. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
identifier_period_end String The end of the identifier-period. Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
version String The identifier that is used to identify this version of the SubscriptionTopic 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.
title String A short, descriptive, user-friendly title for the SubscriptionTopic, for example, admission .
derivedFrom String The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
status String The current state of the SubscriptionTopic.
experimental Bool 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 Datetime For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
publisher String Helps establish the authority/credibility of the SubscriptionTopic. May also allow for contact.
contact String Contact details to assist a user in finding and communicating with the publisher.
description String A free text natural language description of the Topic from the consumer's perspective.
useContext String 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_coding String The coding of the jurisdiction. A jurisdiction in which the Topic is intended to be used.
jurisdiction_text String The text of the jurisdiction. A jurisdiction in which the Topic is intended to be used.
purpose String Explains why this Topic is needed and why it has been designed as it has.
copyright String A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.
approvalDate Date The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDate Date The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
effectivePeriod_start Datetime The start of the effectivePeriod. The period during which the SubscriptionTopic content was or is planned to be effective.
effectivePeriod_end Datetime The end of the effectivePeriod. The period during which the SubscriptionTopic content was or is planned to be effective.
resourceTrigger_id String The resourceTrigger-id of the resourceTrigger-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
resourceTrigger_extension String The resourceTrigger-extension of the resourceTrigger-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
resourceTrigger_modifierExtension String The resourceTrigger-modifierExtension of the resourceTrigger-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
resourceTrigger_description String The resourceTrigger-description of the resourceTrigger-description. The human readable description of this resource trigger for the SubscriptionTopic - for example, An Encounter enters the 'in-progress' state .
resourceTrigger_resource String The resourceTrigger-resource of the resourceTrigger-resource. URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, Patient maps to http://hl7.org/fhir/StructureDefinition/Patient.
resourceTrigger_supportedInteraction String The resourceTrigger-supportedInteraction of the resourceTrigger-supportedInteraction. The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE).
resourceTrigger_queryCriteria_id String The resourceTrigger-queryCriteria-id of the resourceTrigger-queryCriteria-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
resourceTrigger_queryCriteria_extension String The resourceTrigger-queryCriteria-extension of the resourceTrigger-queryCriteria-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
resourceTrigger_queryCriteria_modifierExtension String The resourceTrigger-queryCriteria-modifierExtension of the resourceTrigger-queryCriteria-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
resourceTrigger_queryCriteria_previous String The resourceTrigger-queryCriteria-previous of the resourceTrigger-queryCriteria-previous. The FHIR query based rules are applied to the previous resource state (e.g., state before an update).
resourceTrigger_queryCriteria_resultForCreate String The resourceTrigger-queryCriteria-resultForCreate of the resourceTrigger-queryCriteria-resultForCreate. What behavior a server will exhibit if the previous state of a resource does NOT exist (e.g., prior to a create).
resourceTrigger_queryCriteria_current String The resourceTrigger-queryCriteria-current of the resourceTrigger-queryCriteria-current. The FHIR query based rules are applied to the current resource state (e.g., state after an update).
resourceTrigger_queryCriteria_resultForDelete String The resourceTrigger-queryCriteria-resultForDelete of the resourceTrigger-queryCriteria-resultForDelete. What behavior a server will exhibit if the current state of a resource does NOT exist (e.g., after a DELETE).
resourceTrigger_queryCriteria_requireBoth Bool The resourceTrigger-queryCriteria-requireBoth of the resourceTrigger-queryCriteria-requireBoth. If set to true, both current and previous criteria must evaluate true to trigger a notification for this topic. Otherwise a notification for this topic will be triggered if either one evaluates to true.
resourceTrigger_fhirPathCriteria String The resourceTrigger-fhirPathCriteria of the resourceTrigger-fhirPathCriteria. The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.
eventTrigger_id String The eventTrigger-id of the eventTrigger-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
eventTrigger_extension String The eventTrigger-extension of the eventTrigger-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
eventTrigger_modifierExtension String The eventTrigger-modifierExtension of the eventTrigger-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
eventTrigger_description String The eventTrigger-description of the eventTrigger-description. The human readable description of an event to trigger a notification for the SubscriptionTopic - for example, Patient Admission, as defined in HL7v2 via message ADT^A01 . Multiple values are considered OR joined (e.g., matching any single event listed).
eventTrigger_event_coding String The coding of the eventTrigger-event. A well-defined event which can be used to trigger notifications from the SubscriptionTopic.
eventTrigger_event_text String The text of the eventTrigger-event. A well-defined event which can be used to trigger notifications from the SubscriptionTopic.
eventTrigger_resource String The eventTrigger-resource of the eventTrigger-resource. URL of the Resource that is the focus type used in this event trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, Patient maps to http://hl7.org/fhir/StructureDefinition/Patient.
canFilterBy_id String The canFilterBy-id of the canFilterBy-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
canFilterBy_extension String The canFilterBy-extension of the canFilterBy-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
canFilterBy_modifierExtension String The canFilterBy-modifierExtension of the canFilterBy-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
canFilterBy_description String The canFilterBy-description of the canFilterBy-description. Description of how this filtering parameter is intended to be used.
canFilterBy_resource String The canFilterBy-resource of the canFilterBy-resource. URL of the Resource that is the type used in this filter. This is the focus of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.
canFilterBy_filterParameter String The canFilterBy-filterParameter of the canFilterBy-filterParameter. Either the canonical URL to a search parameter (like http://hl7.org/fhir/SearchParameter/encounter-patient ) or topic-defined parameter (like hub.event ) which is a label for the filter.
canFilterBy_modifier String The canFilterBy-modifier of the canFilterBy-modifier. Allowable operators to apply when determining matches (Search Modifiers).
notificationShape_id String The notificationShape-id of the notificationShape-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
notificationShape_extension String The notificationShape-extension of the notificationShape-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
notificationShape_modifierExtension String The notificationShape-modifierExtension of the notificationShape-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
notificationShape_resource String The notificationShape-resource of the notificationShape-resource. URL of the Resource that is the type used in this shape. This is the focus of the topic (or one of them if there are more than one) and the root resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.
notificationShape_include String The notificationShape-include of the notificationShape-include. Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.
notificationShape_revInclude String The notificationShape-revInclude of the notificationShape-revInclude. Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.
SP_source String The SP_source search parameter.
SP_resource String The SP_resource search parameter.
SP_text String The SP_text search parameter.
SP_content String The SP_content search parameter.
SP_securitySP_start String The SP_securitySP_start search parameter.
SP_tagSP_start String The SP_tagSP_start search parameter.
SP_identifier_start String The SP_identifier_start search parameter.
SP_list String The SP_list search parameter.
SP_identifier_end String The SP_identifier_end search parameter.
SP_profile String The SP_profile search parameter.
SP_tagSP_end String The SP_tagSP_end search parameter.
SP_securitySP_end String The SP_securitySP_end search parameter.
SP_filter String The SP_filter search parameter.
SP_trigger_description String The SP_trigger_description search parameter.
SP_derived_or_self String The SP_derived_or_self search parameter.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062