Others titles
- FHIR Subscription Resource
- Electronic Health Records Exchange Through FHIR
Keywords
- FHIR
- HL7
- Medical Terminology
- Processes Data
- Processes Information
- Processes Documentation
- Health Information Exchange
- Electronic Health Records
- FHIR Smart
- Smart on FHIR
Subscription
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 can take appropriate action.
Get The Data
- ResearchNon-Commercial, Share-Alike, Attribution Free Forever
- CommercialCommercial Use, Remix & Adapt, White Label Log in to download
Description
Once a subscription is created, any newly created or updated resources that meet the criteria in the resource cause a notification to be sent using the provided channel. The criteria are Search strings that have the same interpretation as if they were appended to the base URL and submitted using the REST API. Note that the search criteria are applied to the new value of the resource. The consequence of this is that there is no notification when a resource is deleted, or when a resource is updated so that it no longer meets the criteria.
The server is able to send notifications without any information about the matching resource, or with the entire resource.
Several different types of channels are supported:
– rest-hook: A post is made to the URL identified in the Subscription resource. If the subscription requests that the whole resource is included, the URL is interpreted as the service base
– websocket: A PING message is sent to the designated URI
– email/sms: A notification is sent to the nominated email address or SMS number
– message: The resource is sent to the application identified in the URI as a message
When using the Subscription resource, the FHIR server combines the roles of publisher and information distributer. Other arrangements of the publish and subscribe pattern describe separate agents for the two roles. Implementers may implement the Subscription resource using an architecture with separate agents, or using any other pub/sub architecture.
About this Dataset
Data Info
Date Created | 2018-09-20 |
---|---|
Last Modified | 2023-03-26 |
Version | 5.0.0 |
Update Frequency |
Annual |
Temporal Coverage |
N/A |
Spatial Coverage |
United States |
Source | John Snow Labs; Health Level Seven International; |
Source License URL | |
Source License Requirements |
N/A |
Source Citation |
N/A |
Keywords | FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR |
Other Titles | FHIR Subscription Resource, Electronic Health Records Exchange Through FHIR |
Data Fields
Name | Description | Type | Constraints |
---|---|---|---|
Concept_Name | Name of the concept in the FHIR structure | string | required : 1 |
Computer_Ready_Name | A Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this. | string | - |
Type | The type the structure describes. | string | - |
Dollar_Ref | The "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced. | string | - |
Description | A free text natural language description of the structure and its use | string | - |
Items | The value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value. | string | - |
Enum | The value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value. | string | - |
Required | The value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value. | string | - |
Const | The value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword. | string | - |
Data Preview
Concept Name | Computer Ready Name | Type | Dollar Ref | Description | Items | Enum | Required | Const |
Subscription;resourceType;;;This is a Subscription resource;;;;Subscription | ||||||||
Subscription;id;;#/definitions/id;The logical id of the resource | as used in the URL for the resource. Once assigned | this value never changes.;;;; | ||||||
Subscription;meta;;#/definitions/Meta;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.;;;; | ||||||||
Subscription;implicitRules;;#/definitions/uri;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.;;;; | ||||||
Subscription;_implicitRules;;#/definitions/Element;Extensions for implicitRules;;;; | ||||||||
Subscription;language;;#/definitions/code;The base language in which the resource is written.;;;; | ||||||||
Subscription;_language;;#/definitions/Element;Extensions for language;;;; | ||||||||
Subscription;text;;#/definitions/Narrative;"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.";;;; | |||||||
Subscription;contained;array;;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.;{'$ref': '#/definitions/ResourceList'};;; | |||||||
Subscription;extension;array;;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.;{'$ref': '#/definitions/Extension'};;; |