Annotation

$10 / year

Annotation is a text note which also contains information about who made the statement and when. Systems that do not have structured annotations simply communicate a single annotation with no author or time. This element may need to be included in the narrative because of the potential for modifying information. Annotations should not be used to communicate “modifying” information that could be computable (this is a “should” because enforcing user behavior is nearly impossible).

Complexity

Annotation is used in the following places:
– Allergy Intolerance
– Care Plan
– Care Team
– Charge Item
– Clinical Impression
– Communication
– Communication Request
– Condition
– Contract
– Device
– Device Definition
– Device Request
– Device Use Statement
– Effect Evidence Synthesis
– Evidence
– Evidence Variable
– Family Member History
– Goal
– Guidance Response
– Imaging Study
– Immunization
– Invoice
– List
– Media
– Medication Administration
– Medication Dispense
– Medication Request
– Medication Statement
– Nutrition Order
– Observation
– Procedure
– Request Group
– Research Study
– Risk Assessment
– Risk Evidence Synthesis
– Service Request
– Specimen
– Task and Vision
– Prescription

Fast Healthcare Interoperability Resources (FHIR) is a draft standard describing data formats and elements (known as “resources”) and an application programming interface (API) for exchanging electronic health records. The standard was created by the Health Level Seven International (HL7) health-care standards organization.

Its goal is to facilitate interoperation between legacy healthcare systems, to make it easy to provide healthcare information to healthcare providers and individuals on a wide variety of devices from computers to tablets to cell phones, and to allow third-party application developers to provide medical applications which can be easily integrated into existing systems.

FHIR provides an alternative to document-centric approaches by directly exposing discrete data elements as services. For example, basic elements of healthcare like patients, admissions, diagnostic reports and medications can each be retrieved and manipulated via their own resource URLs (Uniform Resource Locators). FHIR was supported at an American Medical Informatics Association meeting by many EHR (Electronic Health Record) vendors which value its open and extensible nature.

Date Created

2018-09-20

Last Modified

2018-12-27

Version

4.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 Annotation Resource, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structurestringrequired : 1
Computer_Ready_NameA 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-
TypeThe type the structure describes.string-
Dollar_RefThe Dollar_Ref ($ref) is a string value and contains a Uniform Resource Identifier (URI) which identifies the location of (JavaScript Object Notation) the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its usestring-
ItemsThe 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-
Concept NameComputer Ready NameTypeDollar RefDescriptionItems
Annotationid#/definitions/stringUnique ID for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AnnotationextensionarrayMay 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.{'$ref': '#/definitions/Extension'}
AnnotationauthorReference#/definitions/ReferenceThe individual responsible for making the annotation.
AnnotationauthorStringstringThe individual responsible for making the annotation.
Annotation_authorString#/definitions/ElementExtensions for authorString
Annotationtime#/definitions/dateTimeIndicates when this particular annotation was made.
Annotation_time#/definitions/ElementExtensions for time
Annotationtext#/definitions/markdownThe text of the annotation in markdown format.
Annotation_text#/definitions/ElementExtensions for text
Related Data Packages