Release 5 Ballot
FoundationThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for subscription
{
"resourceType" : "StructureDefinition",
"id" : "Subscription",
"meta" : {
"lastUpdated" : "2022-09-07T10:58:29.429+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Subscription",
"version" : "5.0.0-ballot",
"name" : "Subscription",
"status" : "draft",
"experimental" : false,
"date" : "2022-09-07T10:58:29+10:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.",
"fhirVersion" : "5.0.0-ballot",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Subscription",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Subscription",
"path" : "Subscription",
"short" : "Notification about a SubscriptionTopic",
"definition" : "The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.",
"alias" : ["WebHook",
"Hook",
"Routing Rule"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "w5",
"map" : "infrastructure.exchange"
}]
},
{
"id" : "Subscription.id",
"path" : "Subscription.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.meta",
"path" : "Subscription.meta",
"short" : "Metadata about the resource",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.implicitRules",
"path" : "Subscription.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "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.",
"comment" : "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 it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Subscription.language",
"path" : "Subscription.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "IETF language tag",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Subscription.text",
"path" : "Subscription.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "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.",
"comment" : "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.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Subscription.contained",
"path" : "Subscription.contained",
"short" : "Contained, inline Resources",
"definition" : "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.",
"comment" : "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.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.extension",
"path" : "Subscription.extension",
"short" : "Additional content defined by implementations",
"definition" : "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.",
"comment" : "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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.modifierExtension",
"path" : "Subscription.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.identifier",
"path" : "Subscription.identifier",
"short" : "Additional identifiers (business identifier)",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Subscription.name",
"path" : "Subscription.name",
"short" : "Human readable name for this subscription",
"definition" : "A natural language name identifying the subscription.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.status",
"path" : "Subscription.status",
"short" : "requested | active | error | off | entered-in-error",
"definition" : "The status of the subscription, which marks the server state for managing the subscription.",
"comment" : "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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionStatusCodes"
}],
"strength" : "required",
"description" : "The status of a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|5.0.0-ballot"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Subscription.topic",
"path" : "Subscription.topic",
"short" : "Reference to the subscription topic being subscribed to",
"definition" : "The reference to the subscription topic to be notified about.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.topic",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "Subscription.contact",
"path" : "Subscription.contact",
"short" : "Contact details for source (e.g. troubleshooting)",
"definition" : "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Subscription.end",
"path" : "Subscription.end",
"short" : "When to automatically delete the subscription",
"definition" : "The time for the server to turn the subscription off.",
"comment" : "The server is permitted to deviate from this time but should observe it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Subscription.managingEntity",
"path" : "Subscription.managingEntity",
"short" : "Entity responsible for Subscription changes",
"definition" : "Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.managingEntity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "Subscription.reason",
"path" : "Subscription.reason",
"short" : "Description of why this subscription was created",
"definition" : "A description of why this subscription is defined.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.reason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "Subscription.filterBy",
"path" : "Subscription.filterBy",
"short" : "Criteria for narrowing the subscription topic stream",
"definition" : "The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription.filterBy",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.filterBy.id",
"path" : "Subscription.filterBy.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Subscription.filterBy.extension",
"path" : "Subscription.filterBy.extension",
"short" : "Additional content defined by implementations",
"definition" : "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.",
"comment" : "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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Subscription.filterBy.modifierExtension",
"path" : "Subscription.filterBy.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.filterBy.resourceType",
"path" : "Subscription.filterBy.resourceType",
"short" : "Allowed Data type or Resource (reference to definition) for this Subscription",
"definition" : "If the element is a reference to another resource, this element contains \"Reference\", and the targetProfile element defines what resources can be referenced. The targetProfile may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.filterBy.resourceType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRTypes"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "A type of resource, or a Reference",
"valueSet" : "http://hl7.org/fhir/ValueSet/fhir-types"
}
},
{
"id" : "Subscription.filterBy.filterParameter",
"path" : "Subscription.filterBy.filterParameter",
"short" : "Filter label defined in SubscriptionTopic",
"definition" : "The filter as defined in the `SubscriptionTopic.canfilterBy.filterParameter` element.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.filterBy.filterParameter",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.filterBy.modifier",
"path" : "Subscription.filterBy.modifier",
"short" : "= | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type",
"definition" : "Operator to apply when determining matches (Search Modifiers), from the list of allowed modifiers for this filter in the relevant SubscriptionTopic.",
"comment" : "If filterDefinition refers to a SearchParameter, then the modifiers indicated must be allowed by the SearchParameter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.filterBy.modifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionFilterBySearchModifier"
}],
"strength" : "required",
"description" : "Operator to apply to filter label.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-search-modifier|5.0.0-ballot"
}
},
{
"id" : "Subscription.filterBy.value",
"path" : "Subscription.filterBy.value",
"short" : "Literal value or resource path",
"definition" : "The literal value or resource path as is legal in search - for example, \"Patient/123\" or \"le1950\".",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.filterBy.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.channelType",
"path" : "Subscription.channelType",
"short" : "Channel type for notifications",
"definition" : "The type of channel to send notifications on.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.channelType",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionChannelType"
}],
"strength" : "extensible",
"description" : "The type of method used to execute a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-channel-type"
}
},
{
"id" : "Subscription.endpoint",
"path" : "Subscription.endpoint",
"short" : "Where the channel points to",
"definition" : "The url that describes the actual end-point to send messages to.",
"comment" : "For rest-hook the end-point must be an http: or https: URL; for websocket 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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.endpoint",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.header",
"path" : "Subscription.header",
"short" : "Usage depends on the channel type",
"definition" : "Additional headers / information to send as part of the notification.",
"comment" : "Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription.header",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.heartbeatPeriod",
"path" : "Subscription.heartbeatPeriod",
"short" : "Interval in seconds to send 'heartbeat' notification",
"definition" : "If present, a 'hearbeat\" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.heartbeatPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.timeout",
"path" : "Subscription.timeout",
"short" : "Timeout in seconds to attempt notification delivery",
"definition" : "If present, the maximum amount of time a server will allow before failing a notification attempt.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.timeout",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.contentType",
"path" : "Subscription.contentType",
"short" : "MIME type to send, or omit for no payload",
"definition" : "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types \"text/plain\" and \"text/html\" may also be used for Email subscriptions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.contentType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0-ballot"
}
},
{
"id" : "Subscription.content",
"path" : "Subscription.content",
"short" : "empty | id-only | full-resource",
"definition" : "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.",
"comment" : "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.content",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionPayloadContent"
}],
"strength" : "required",
"description" : "Codes to represent how much resource content to send in the notification payload.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-payload-content|5.0.0-ballot"
}
},
{
"id" : "Subscription.maxCount",
"path" : "Subscription.maxCount",
"short" : "Maximum number of triggering resources included in notification bundles",
"definition" : "If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.maxCount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "Subscription",
"path" : "Subscription",
"short" : "Notification about a SubscriptionTopic",
"definition" : "The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.",
"alias" : ["WebHook",
"Hook",
"Routing Rule"],
"min" : 0,
"max" : "*",
"mustSupport" : false,
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "w5",
"map" : "infrastructure.exchange"
}]
},
{
"id" : "Subscription.identifier",
"path" : "Subscription.identifier",
"short" : "Additional identifiers (business identifier)",
"definition" : "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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Subscription.name",
"path" : "Subscription.name",
"short" : "Human readable name for this subscription",
"definition" : "A natural language name identifying the subscription.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.status",
"path" : "Subscription.status",
"short" : "requested | active | error | off | entered-in-error",
"definition" : "The status of the subscription, which marks the server state for managing the subscription.",
"comment" : "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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionStatusCodes"
}],
"strength" : "required",
"description" : "The status of a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|5.0.0-ballot"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Subscription.topic",
"path" : "Subscription.topic",
"short" : "Reference to the subscription topic being subscribed to",
"definition" : "The reference to the subscription topic to be notified about.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "Subscription.contact",
"path" : "Subscription.contact",
"short" : "Contact details for source (e.g. troubleshooting)",
"definition" : "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Subscription.end",
"path" : "Subscription.end",
"short" : "When to automatically delete the subscription",
"definition" : "The time for the server to turn the subscription off.",
"comment" : "The server is permitted to deviate from this time but should observe it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Subscription.managingEntity",
"path" : "Subscription.managingEntity",
"short" : "Entity responsible for Subscription changes",
"definition" : "Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "Subscription.reason",
"path" : "Subscription.reason",
"short" : "Description of why this subscription was created",
"definition" : "A description of why this subscription is defined.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "Subscription.filterBy",
"path" : "Subscription.filterBy",
"short" : "Criteria for narrowing the subscription topic stream",
"definition" : "The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.filterBy.resourceType",
"path" : "Subscription.filterBy.resourceType",
"short" : "Allowed Data type or Resource (reference to definition) for this Subscription",
"definition" : "If the element is a reference to another resource, this element contains \"Reference\", and the targetProfile element defines what resources can be referenced. The targetProfile may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRTypes"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "A type of resource, or a Reference",
"valueSet" : "http://hl7.org/fhir/ValueSet/fhir-types"
}
},
{
"id" : "Subscription.filterBy.filterParameter",
"path" : "Subscription.filterBy.filterParameter",
"short" : "Filter label defined in SubscriptionTopic",
"definition" : "The filter as defined in the `SubscriptionTopic.canfilterBy.filterParameter` element.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.filterBy.modifier",
"path" : "Subscription.filterBy.modifier",
"short" : "= | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type",
"definition" : "Operator to apply when determining matches (Search Modifiers), from the list of allowed modifiers for this filter in the relevant SubscriptionTopic.",
"comment" : "If filterDefinition refers to a SearchParameter, then the modifiers indicated must be allowed by the SearchParameter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionFilterBySearchModifier"
}],
"strength" : "required",
"description" : "Operator to apply to filter label.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-search-modifier|5.0.0-ballot"
}
},
{
"id" : "Subscription.filterBy.value",
"path" : "Subscription.filterBy.value",
"short" : "Literal value or resource path",
"definition" : "The literal value or resource path as is legal in search - for example, \"Patient/123\" or \"le1950\".",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.channelType",
"path" : "Subscription.channelType",
"short" : "Channel type for notifications",
"definition" : "The type of channel to send notifications on.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionChannelType"
}],
"strength" : "extensible",
"description" : "The type of method used to execute a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-channel-type"
}
},
{
"id" : "Subscription.endpoint",
"path" : "Subscription.endpoint",
"short" : "Where the channel points to",
"definition" : "The url that describes the actual end-point to send messages to.",
"comment" : "For rest-hook the end-point must be an http: or https: URL; for websocket 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).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "url"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.header",
"path" : "Subscription.header",
"short" : "Usage depends on the channel type",
"definition" : "Additional headers / information to send as part of the notification.",
"comment" : "Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.heartbeatPeriod",
"path" : "Subscription.heartbeatPeriod",
"short" : "Interval in seconds to send 'heartbeat' notification",
"definition" : "If present, a 'hearbeat\" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.timeout",
"path" : "Subscription.timeout",
"short" : "Timeout in seconds to attempt notification delivery",
"definition" : "If present, the maximum amount of time a server will allow before failing a notification attempt.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.contentType",
"path" : "Subscription.contentType",
"short" : "MIME type to send, or omit for no payload",
"definition" : "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types \"text/plain\" and \"text/html\" may also be used for Email subscriptions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0-ballot"
}
},
{
"id" : "Subscription.content",
"path" : "Subscription.content",
"short" : "empty | id-only | full-resource",
"definition" : "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.",
"comment" : "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionPayloadContent"
}],
"strength" : "required",
"description" : "Codes to represent how much resource content to send in the notification payload.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-payload-content|5.0.0-ballot"
}
},
{
"id" : "Subscription.maxCount",
"path" : "Subscription.maxCount",
"short" : "Maximum number of triggering resources included in notification bundles",
"definition" : "If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
}]
}
}
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 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:11+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change