{
"description": "Base StructureDefinition for Subscription Resource",
"_filename": "StructureDefinition-Subscription.json",
"package_name": "hl7.fhir.r2.core",
"date": "2015-10-24T07:41:03+11:00",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
},
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"fhirVersion": "1.0.2",
"name": "Subscription",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": null,
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.2",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
} ],
"snapshot": {
"element": [ {
"path": "Subscription",
"min": 0,
"definition": "The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system is able to take an appropriate action.",
"short": "A server push subscription criteria",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "infrastructure.exchange",
"identity": "w5"
} ],
"type": [ {
"code": "DomainResource"
} ],
"alias": [ "WebHook", "Hook", "Routing Rule" ],
"max": "*",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "Subscription.id",
"type": [ {
"code": "id"
} ],
"short": "Logical id of this artifact",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"isSummary": true,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."
}, {
"max": "1",
"min": 0,
"path": "Subscription.meta",
"type": [ {
"code": "Meta"
} ],
"short": "Metadata about the resource",
"isSummary": true,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."
}, {
"path": "Subscription.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"comments": "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 as much as possible.",
"type": [ {
"code": "uri"
} ],
"max": "1",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "Subscription.language",
"type": [ {
"code": "code"
} ],
"short": "Language of the resource content",
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"comments": "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).",
"definition": "The base language in which the resource is written."
}, {
"path": "Subscription.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"short": "Text summary of the resource, for human interpretation",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"condition": [ "dom-1" ]
}, {
"path": "Subscription.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*"
}, {
"path": "Subscription.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*"
}, {
"path": "Subscription.modifierExtension",
"min": 0,
"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. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*"
}, {
"max": "1",
"min": 1,
"path": "Subscription.criteria",
"type": [ {
"code": "string"
} ],
"short": "Rule for server push criteria",
"comments": "The rules are a search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
"isSummary": true,
"definition": "The rules that the server should use to determine when to generate notifications for this subscription."
}, {
"max": "*",
"min": 0,
"path": "Subscription.contact",
"type": [ {
"code": "ContactPoint"
} ],
"short": "Contact details for source (e.g. troubleshooting)",
"mapping": [ {
"map": "who.focus",
"identity": "w5"
} ],
"isSummary": true,
"definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting."
}, {
"max": "1",
"min": 1,
"path": "Subscription.reason",
"type": [ {
"code": "string"
} ],
"short": "Description of why this subscription was created",
"mapping": [ {
"map": "why",
"identity": "w5"
} ],
"isSummary": true,
"definition": "A description of why this subscription is defined."
}, {
"path": "Subscription.status",
"min": 1,
"definition": "The status of the subscription, which marks the server state for managing the subscription.",
"isModifier": true,
"short": "requested | active | error | off",
"comments": "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.",
"mapping": [ {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The status of a subscription.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/subscription-status"
}
},
"max": "1",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "Subscription.error",
"type": [ {
"code": "string"
} ],
"short": "Latest error note",
"isSummary": true,
"definition": "A record of the last error that occurred when the server processed a notification."
}, {
"max": "1",
"min": 1,
"path": "Subscription.channel",
"type": [ {
"code": "BackboneElement"
} ],
"short": "The channel on which to report matches to the criteria",
"isSummary": true,
"definition": "Details where to send notifications when resources are received that meet the criteria."
}, {
"max": "1",
"min": 0,
"path": "Subscription.channel.id",
"type": [ {
"code": "id"
} ],
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"definition": "unique id for the element within a resource (for internal references).",
"representation": [ "xmlAttr" ]
}, {
"path": "Subscription.channel.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"comments": "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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*"
}, {
"path": "Subscription.channel.modifierExtension",
"min": 0,
"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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"comments": "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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*"
}, {
"max": "1",
"min": 1,
"path": "Subscription.channel.type",
"type": [ {
"code": "code"
} ],
"short": "rest-hook | websocket | email | sms | message",
"binding": {
"strength": "required",
"description": "The type of method used to execute a subscription.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/subscription-channel-type"
}
},
"isSummary": true,
"definition": "The type of channel to send notifications on."
}, {
"max": "1",
"min": 0,
"path": "Subscription.channel.endpoint",
"type": [ {
"code": "uri"
} ],
"short": "Where the channel points to",
"comments": "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs).",
"isSummary": true,
"definition": "The uri that describes the actual end-point to send messages to."
}, {
"max": "1",
"min": 1,
"path": "Subscription.channel.payload",
"type": [ {
"code": "string"
} ],
"short": "Mimetype to send, or blank for no payload",
"comments": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"isSummary": true,
"definition": "The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification."
}, {
"max": "1",
"min": 0,
"path": "Subscription.channel.header",
"type": [ {
"code": "string"
} ],
"short": "Usage depends on the channel type",
"comments": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"isSummary": true,
"definition": "Additional headers / information to send as part of the notification."
}, {
"path": "Subscription.end",
"min": 0,
"definition": "The time for the server to turn the subscription off.",
"short": "When to automatically delete the subscription",
"comments": "The server is permitted to deviate from this time, but should observe it.",
"mapping": [ {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"isSummary": true
}, {
"path": "Subscription.tag",
"min": 0,
"definition": "A tag to add to any resource that matches the criteria, after the subscription is processed.",
"short": "A tag to add to matching resources",
"comments": "So that other systems can tell which resources have been the subject of a notification.",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"description": "Tags to put on a resource after subscriptions have been sent.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/subscription-tag"
}
},
"max": "*",
"isSummary": true
} ]
},
"status": "draft",
"id": "5359dac5-e723-4eb5-871d-1baae1f8ef39",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/Subscription",
"base": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"version": null,
"differential": {
"element": [ {
"path": "Subscription",
"min": 0,
"definition": "The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system is able to take an appropriate action.",
"short": "A server push subscription criteria",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "infrastructure.exchange",
"identity": "w5"
} ],
"type": [ {
"code": "DomainResource"
} ],
"alias": [ "WebHook", "Hook", "Routing Rule" ],
"max": "*",
"isSummary": true
}, {
"max": "1",
"min": 1,
"path": "Subscription.criteria",
"type": [ {
"code": "string"
} ],
"short": "Rule for server push criteria",
"comments": "The rules are a search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
"isSummary": true,
"definition": "The rules that the server should use to determine when to generate notifications for this subscription."
}, {
"max": "*",
"min": 0,
"path": "Subscription.contact",
"type": [ {
"code": "ContactPoint"
} ],
"short": "Contact details for source (e.g. troubleshooting)",
"mapping": [ {
"map": "who.focus",
"identity": "w5"
} ],
"isSummary": true,
"definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting."
}, {
"max": "1",
"min": 1,
"path": "Subscription.reason",
"type": [ {
"code": "string"
} ],
"short": "Description of why this subscription was created",
"mapping": [ {
"map": "why",
"identity": "w5"
} ],
"isSummary": true,
"definition": "A description of why this subscription is defined."
}, {
"path": "Subscription.status",
"min": 1,
"definition": "The status of the subscription, which marks the server state for managing the subscription.",
"isModifier": true,
"short": "requested | active | error | off",
"comments": "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.",
"mapping": [ {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The status of a subscription.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/subscription-status"
}
},
"max": "1",
"isSummary": true
}, {
"max": "1",
"min": 0,
"path": "Subscription.error",
"type": [ {
"code": "string"
} ],
"short": "Latest error note",
"isSummary": true,
"definition": "A record of the last error that occurred when the server processed a notification."
}, {
"max": "1",
"min": 1,
"path": "Subscription.channel",
"type": [ {
"code": "BackboneElement"
} ],
"short": "The channel on which to report matches to the criteria",
"isSummary": true,
"definition": "Details where to send notifications when resources are received that meet the criteria."
}, {
"max": "1",
"min": 1,
"path": "Subscription.channel.type",
"type": [ {
"code": "code"
} ],
"short": "rest-hook | websocket | email | sms | message",
"binding": {
"strength": "required",
"description": "The type of method used to execute a subscription.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/subscription-channel-type"
}
},
"isSummary": true,
"definition": "The type of channel to send notifications on."
}, {
"max": "1",
"min": 0,
"path": "Subscription.channel.endpoint",
"type": [ {
"code": "uri"
} ],
"short": "Where the channel points to",
"comments": "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs).",
"isSummary": true,
"definition": "The uri that describes the actual end-point to send messages to."
}, {
"max": "1",
"min": 1,
"path": "Subscription.channel.payload",
"type": [ {
"code": "string"
} ],
"short": "Mimetype to send, or blank for no payload",
"comments": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"isSummary": true,
"definition": "The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification."
}, {
"max": "1",
"min": 0,
"path": "Subscription.channel.header",
"type": [ {
"code": "string"
} ],
"short": "Usage depends on the channel type",
"comments": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"isSummary": true,
"definition": "Additional headers / information to send as part of the notification."
}, {
"path": "Subscription.end",
"min": 0,
"definition": "The time for the server to turn the subscription off.",
"short": "When to automatically delete the subscription",
"comments": "The server is permitted to deviate from this time, but should observe it.",
"mapping": [ {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"isSummary": true
}, {
"path": "Subscription.tag",
"min": 0,
"definition": "A tag to add to any resource that matches the criteria, after the subscription is processed.",
"short": "A tag to add to matching resources",
"comments": "So that other systems can tell which resources have been the subject of a notification.",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"description": "Tags to put on a resource after subscriptions have been sent.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/subscription-tag"
}
},
"max": "*",
"isSummary": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "other"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm",
"system": "other"
} ]
} ]
}