Others titles
- FHIR Message Definition 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
Message Definition

This dataset defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
Get The Data
- Research
Non-Commercial,
Share-Alike,
Attribution Free Forever
- Commercial
Commercial Use,
Remix & Adapt,
White Label Log in to download
Description
Message resource refers to a type of message that can be exchanged between systems. Every message is designed with a purpose and the context of the message defines why it is needed and why it has been designed as it has. A message also has a base for its content and that content has an impact or consequence.
The message represents/requests a change also known as the ‘consequence’ that should not be processed more than once; e.g., making a booking for an appointment. It also represents a response to query for current information. Retrospective processing is wrong and/or wasteful. The content of the message is not necessarily intended to be current, and it can be reprocessed, though there may be version issues created by processing old notifications.
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 Message Definition 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 enum is used to restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique. | 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 |
MessageDefinition | resourceType | This is a MessageDefinition resource | MessageDefinition | |||||
MessageDefinition | id | #/definitions/id | The logical id of the resource | |||||
MessageDefinition | 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. | |||||
MessageDefinition | implicitRules | #/definitions/uri | A reference to a set of rules that were followed when the resource was constructed | |||||
MessageDefinition | _implicitRules | #/definitions/Element | Extensions for implicitRules | |||||
MessageDefinition | language | #/definitions/code | The base language in which the resource is written. | |||||
MessageDefinition | _language | #/definitions/Element | Extensions for language | |||||
MessageDefinition | 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 | |||||
MessageDefinition | contained | array | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently | |||||
MessageDefinition | 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 |