Release 5
FoundationThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is a downloaded copy of the specification. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
Raw XML (canonical form + also see XML Format Specification)
Generated Questionnaire for Subscription
<?xml version="1.0" encoding="UTF-8"?>
<Questionnaire xmlns="http://hl7.org/fhir">
<id value="qgen-Subscription1"/>
<url value="http://hl7.org/fhir/Questionnaire/qgen-Subscription1"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
</identifier>
<version value="5.0.0"/>
<status value="draft"/>
<experimental value="false"/>
<date value="2023-03-26T15:21:02+11:00"/>
<publisher value="Health Level Seven International (FHIR Infrastructure)"/>
<item>
<linkId value="Subscription"/>
<text value="Notification about a SubscriptionTopic"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription-flyover"/>
<text value="The subscription resource describes a particular client's request to be notified about a SubscriptionTopic."/>
<type value="display"/>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.id"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.id-flyover"/>
<text value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.id.value"/>
<text value="Logical id of this artifact"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<linkId value="Subscription.meta"/>
<text value="Metadata about the resource"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.meta-flyover"/>
<text value="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."/>
<type value="display"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="uri"/>
</extension>
<linkId value="Subscription.implicitRules"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.implicitRules-flyover"/>
<text value="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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.implicitRules.value"/>
<text value="A set of rules under which this content was created"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="code"/>
</extension>
<linkId value="Subscription.language"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.language-flyover"/>
<text value="The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.language.value"/>
<text value="language"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOrType"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<linkId value="Subscription.text"/>
<text value="Text summary of the resource, for human interpretation"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.text-flyover"/>
<text value="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 resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later."/>
<type value="display"/>
</item>
</item>
<item>
<linkId value="Subscription.contained"/>
<text value="Contained, inline Resources"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.contained-flyover"/>
<text value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels."/>
<type value="display"/>
</item>
</item>
<item>
<linkId value="Subscription.extension"/>
<text value="Additional content defined by implementations"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.extension-flyover"/>
<text value="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 managable, 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<type value="display"/>
</item>
</item>
<item>
<linkId value="Subscription.modifierExtension"/>
<text value="Extensions that cannot be ignored"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.modifierExtension-flyover"/>
<text value="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 managable, 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). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<type value="display"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="Identifier"/>
</extension>
<linkId value="Subscription.identifier"/>
<text value="Additional identifiers (business identifier)"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.identifier-flyover"/>
<text value="A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.identifier.label"/>
<text value="label:"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
<item>
<linkId value="Subscription.identifier.system"/>
<text value="system:"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
<item>
<linkId value="Subscription.identifier.value"/>
<text value="value:"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.name"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.name-flyover"/>
<text value="A natural language name identifying the subscription."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.name.value"/>
<text value="Human readable name for this subscription"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="code"/>
</extension>
<linkId value="Subscription.status"/>
<type value="group"/>
<required value="true"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.status-flyover"/>
<text value="The status of the subscription, which marks the server state for managing the subscription. A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.status.value"/>
<text value="status"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOrType"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="uri"/>
</extension>
<linkId value="Subscription.topic"/>
<type value="group"/>
<required value="true"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.topic-flyover"/>
<text value="The reference to the subscription topic to be notified about."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.topic.value"/>
<text value="Reference to the subscription topic being subscribed to"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="ContactPoint"/>
</extension>
<linkId value="Subscription.contact"/>
<text value="Contact details for source (e.g. troubleshooting)"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.contact-flyover"/>
<text value="Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.contact.system"/>
<text value="type:"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOnly"/>
</item>
<item>
<linkId value="Subscription.contact.value"/>
<text value="value:"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
<item>
<linkId value="Subscription.contact.use"/>
<text value="use:"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOnly"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="instant"/>
</extension>
<linkId value="Subscription.end"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.end-flyover"/>
<text value="The time for the server to turn the subscription off. The server is permitted to deviate from this time but should observe it."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.end.value"/>
<text value="When to automatically delete the subscription"/>
<type value="dateTime"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="Reference"/>
</extension>
<linkId value="Subscription.managingEntity"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.managingEntity-flyover"/>
<text value="Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose."/>
<type value="display"/>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource">
<valueCode value="CareTeam, HealthcareService, Organization, RelatedPerson, Patient, Practitioner, PractitionerRole"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter">
<valueString value="subject=$subj&patient=$subj&encounter=$encounter"/>
</extension>
<linkId value="Subscription.managingEntity.value"/>
<text value="Entity responsible for Subscription changes"/>
<type value="reference"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.reason"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.reason-flyover"/>
<text value="A description of why this subscription is defined."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.reason.value"/>
<text value="Description of why this subscription was created"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<linkId value="Subscription.filterBy"/>
<text value="Criteria for narrowing the subscription topic stream"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy-flyover"/>
<text value="The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND)."/>
<type value="display"/>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.filterBy.id"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.id-flyover"/>
<text value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.filterBy.id.value"/>
<text value="Unique id for inter-element referencing"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<linkId value="Subscription.filterBy.extension"/>
<text value="Additional content defined by implementations"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.extension-flyover"/>
<text value="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 managable, 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<type value="display"/>
</item>
</item>
<item>
<linkId value="Subscription.filterBy.modifierExtension"/>
<text value="Extensions that cannot be ignored even if unrecognized"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.modifierExtension-flyover"/>
<text value="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 managable, 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). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<type value="display"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="uri"/>
</extension>
<linkId value="Subscription.filterBy.resourceType"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.resourceType-flyover"/>
<text value="A resource listed in the `SubscriptionTopic` this `Subscription` references (`SubscriptionTopic.canFilterBy.resource`). This element can be used to differentiate filters for topics that include more than one resource type."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.filterBy.resourceType.value"/>
<text value="Allowed Resource (reference to definition) for this Subscription filter"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.filterBy.filterParameter"/>
<type value="group"/>
<required value="true"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.filterParameter-flyover"/>
<text value="The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.filterBy.filterParameter.value"/>
<text value="Filter label defined in SubscriptionTopic"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="code"/>
</extension>
<linkId value="Subscription.filterBy.comparator"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.comparator-flyover"/>
<text value="Comparator applied to this filter parameter. Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.filterBy.comparator.value"/>
<text value="comparator"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOrType"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="code"/>
</extension>
<linkId value="Subscription.filterBy.modifier"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.modifier-flyover"/>
<text value="Modifier applied to this filter parameter. Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.filterBy.modifier.value"/>
<text value="modifier"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOrType"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.filterBy.value"/>
<type value="group"/>
<required value="true"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.filterBy.value-flyover"/>
<text value="The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.filterBy.value.value"/>
<text value="Literal value or resource path"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="Coding"/>
</extension>
<linkId value="Subscription.channelType"/>
<type value="group"/>
<required value="true"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.channelType-flyover"/>
<text value="The type of channel to send notifications on."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.channelType.value"/>
<text value="Channel type for notifications"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOnly"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="uri"/>
</extension>
<linkId value="Subscription.endpoint"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.endpoint-flyover"/>
<text value="The url that describes the actual end-point to send notifications to. For rest-hook the end-point must be an `http:` or `https:` URL; for websockets, `ws:` or `wss:`; for email, a `mailto:` url; and for message the endpoint can be in any form of url the server understands (usually, `http/s`: or `mllp:`). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.endpoint.value"/>
<text value="Where the channel points to"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<linkId value="Subscription.parameter"/>
<text value="Channel type"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<linkId value="Subscription.parameter-display"/>
<text value="Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions."/>
<type value="display"/>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.parameter-flyover"/>
<text value="Channel-dependent information to send as part of the notification (e.g., HTTP Headers)."/>
<type value="display"/>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.parameter.id"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.parameter.id-flyover"/>
<text value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.parameter.id.value"/>
<text value="Unique id for inter-element referencing"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<linkId value="Subscription.parameter.extension"/>
<text value="Additional content defined by implementations"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.parameter.extension-flyover"/>
<text value="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 managable, 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<type value="display"/>
</item>
</item>
<item>
<linkId value="Subscription.parameter.modifierExtension"/>
<text value="Extensions that cannot be ignored even if unrecognized"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.parameter.modifierExtension-flyover"/>
<text value="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 managable, 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). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<type value="display"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.parameter.name"/>
<type value="group"/>
<required value="true"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.parameter.name-flyover"/>
<text value="Parameter name for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the name would be Authorization."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.parameter.name.value"/>
<text value="Name (key) of the parameter"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="string"/>
</extension>
<linkId value="Subscription.parameter.value"/>
<type value="group"/>
<required value="true"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.parameter.value-flyover"/>
<text value="Parameter value for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the value would be `Bearer 0193...`."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.parameter.value.value"/>
<text value="Value of the parameter to use or pass through"/>
<type value="string"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="integer"/>
</extension>
<linkId value="Subscription.heartbeatPeriod"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.heartbeatPeriod-flyover"/>
<text value="If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.heartbeatPeriod.value"/>
<text value="Interval in seconds to send 'heartbeat' notification"/>
<type value="integer"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="integer"/>
</extension>
<linkId value="Subscription.timeout"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.timeout-flyover"/>
<text value="If present, the maximum amount of time a server will allow before failing a notification attempt."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.timeout.value"/>
<text value="Timeout in seconds to attempt notification delivery"/>
<type value="integer"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="code"/>
</extension>
<linkId value="Subscription.contentType"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.contentType-flyover"/>
<text value="The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that:

* clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`.

* additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.contentType.value"/>
<text value="content type"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOrType"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="code"/>
</extension>
<linkId value="Subscription.content"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.content-flyover"/>
<text value="How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.content.value"/>
<text value="content"/>
<type value="coding"/>
<required value="false"/>
<repeats value="false"/>
<answerConstraint value="optionsOrType"/>
</item>
</item>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
<valueInteger value="1"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
<valueString value="integer"/>
</extension>
<linkId value="Subscription.maxCount"/>
<type value="group"/>
<required value="false"/>
<repeats value="true"/>
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
<valueCodeableConcept>
<coding>
<system value="http://hl7.org/fhir/questionnaire-item-control"/>
<code value="flyover"/>
<display value="Fly-over"/>
</coding>
</valueCodeableConcept>
</extension>
<linkId value="Subscription.maxCount-flyover"/>
<text value="If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included."/>
<type value="display"/>
</item>
<item>
<linkId value="Subscription.maxCount.value"/>
<text value="Maximum number of events that can be combined in a single notification"/>
<type value="integer"/>
<required value="false"/>
<repeats value="false"/>
</item>
</item>
</item>
</Questionnaire>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:26+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change