emtelliPro JSON result specification, version 2.27.0¶

Download JSON Schema specification: emtellipro-result-json-v2.schema.json

Result¶

emtelliPro JSON result specification, version 2.27.0.
type	object
properties
format	The name of the result schema specified by this document.
	type	string
	enum	emtellipro-json-2
version	The version of the schema used for this result.
	type	string
engine-version	The engine version used to produce this result.
	type	string
documents	An array where each element is the per-document result output.
	type	array
	items
		Document

Document¶

The result from emtelliPro corresponding to one of the input documents.
type	object
properties
id	Identifier for the document, indicating which input document it corresponds to.
	DocumentID
attributes	Attributes for this document specifying document level information.
	DocumentAttributes
processing_status	Status of processing of this document.
	ProcessingStatus
ontology_versions	Version information for the ontologies used to process this document.
	type	object
	properties
	emtelligent	Version information for the Emtelligent ontology. Present when the ‘emtelligent-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	snomed	Version information for the SNOMED ontology. Present when the ‘snomed-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	radlex	Version information for the RadLex ontology. Present when the ‘radlex-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	umls_nci	Version information for the UMLS NCI ontology. Present when the ‘umlsnci-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	medcin	Version information for the MEDCIN ontology. Present when the ‘medcin-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	rxnorm	Version information for the RxNorm ontology. Present when the ‘rxnorm-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	umls_hgnc	Version information for the UMLS HGNC ontology. Present when the ‘umlshgnc-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	umls_loinc	Version information for the UMLS LOINC ontology. Present when the ‘umlsloinc-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	snomed_icd10	ICD10 codes obtained by mapping from the SNOMED CT ontology. Present when the ‘snomedicd10-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	snomed_icd10_cm	ICD10-CM codes obtained by mapping from the SNOMED CT ontology. Present when the ‘snomedicd10cm-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
	rad_playbook	Version information for the LOINC/RSNA Radiology Playbook ontology. Present when the ‘radplaybook-ontology’ feature is enabled and the ontology is used to produce output.
		OntologyVersionInfo
text	Text of the whole report. This field is present if the input document did not include the plain text itself.
	type	string
entities	Named Entities in this document. The entities are typically associated with spans in the text but some relations introduce assumed entities.
	type	object
	properties
	found	type	array
		items
			FoundEntity
	assumed	type	array
		items
			AssumedEntity
concepts	Concepts in this document.
	type	object
	properties
	emtelligent	Concepts from the Emtelligent ontology. Present when the ‘emtelligent-ontology’ feature is enabled.
		type	array
		items
			Concept
	snomed	Concepts from the SNOMED ontology. Present when the ‘snomed-ontology’ feature is enabled.
		type	array
		items
			Concept
	radlex	Concepts from the RadLex ontology. Present when the ‘radlex-ontology’ feature is enabled.
		type	array
		items
			Concept
	umls_nci	Concepts from the UMLS NCI ontology. Present when the ‘umlsnci-ontology’ feature is enabled.
		type	array
		items
			Concept
	medcin	Concepts from the MEDCIN ontology. Present when the ‘medcin-ontology’ feature is enabled.
		type	array
		items
			Concept
	rxnorm	Concepts from the RxNorm ontology. Present when the ‘rxnorm-ontology’ feature is enabled.
		type	array
		items
			Concept
	umls_hgnc	Concepts from the UMLS HGNC ontology. Present when the ‘umlshgnc-ontology’ feature is enabled.
		type	array
		items
			Concept
	umls_loinc	Concepts from the UMLS LOINC ontology. Present when the ‘umlsloinc-ontology’ feature is enabled.
		type	array
		items
			Concept
	snomed_icd10	ICD10 codes obtained by mapping from the SNOMED CT ontology. Present when the ‘snomedicd10-ontology’ feature is enabled.
		type	array
		items
			Concept
	snomed_icd10_cm	ICD10-CM codes obtained by mapping from the SNOMED CT ontology. Present when the ‘snomedicd10cm-ontology’ feature is enabled.
		type	array
		items
			Concept
	rad_playbook	Concepts from the LOINC/RSNA Radiology Playbook ontology. Present when the ‘radplaybook-ontology’ feature is enabled.
		type	array
		items
			Concept
relations	Relations between entities found in this document.
	type	object
	properties
	experiencers	Relations indicating that an person experiences some condition. Present when the ‘experiencer-relations’ feature is enabled.
		type	array
		items
			ExperiencerRelation
	followups	Relations indicating a requested followup for a certain procedure in an optionally specified timeframe. Present when the ‘followup-relations’ feature is enabled.
		type	array
		items
			FollowupRelation
	measurements	Relations indicating the measurement of morphological abnormalities or anatomical sites.
		type	array
		items
			MeasurementRelation
	imagelinks	Relations indicating a reference to an image or image slice, and to findings in that image. There may be multiple references to images and findings in a single relation.
		type	array
		items
			ImageLinkRelation
	qualifiers	Relations indicating a qualifier value modifying morphological abnormalities or anatomical sites. The qualifiers have many different types such as ‘size/severity’ and many other types. The types are expressed as an attribute of this relation. Each relation is expressed for each entity and its qualifier value. The same qualifier may modify multiple entities.
		type	array
		items
			QualifierRelation
	medications	Relations capturing the various pieces of information associated with a medication prescription.
		type	array
		items
			MedicationRelation
	temporalities	Relations indicating something to do with temporality.
		type	array
		items
			TemporalityRelation
	reportedevents	Relations capturing the notion of a communication between two groups of entities. Present when the ‘reportedevent-releation’ feature is enabled.
		type	array
		items
			ReportedEventRelation
locations	Locations in text in this document. Will be present if any feature is enabled which generates entities from text.
	type	object
	properties
	sentences	type	array
		items
			SentenceLocation
	sections	type	array
		items
			SectionLocation

DocumentID¶

Identifier for a document. Must be unique within each submission, and will indicate which result document corresponds to which input document.
type	string

DocumentAttributes¶

Attributes describing a document, with each property being one attribute keyed by name.
type	object
properties
category	DocumentStringAttribute
subcategory	DocumentStringAttribute

DocumentAttribute¶

Attribute describing a document.
type	object
properties
method	The method for detection of a document attribute: ‘manual’ if it was set explicitly in input, and ‘automatic’ if it was detected by the server.
	type	string
	enum	manual, automatic
value	Value of this attribute.

DocumentStringAttribute¶

allOf	DocumentAttribute
	type	object
	properties
	value	type	string

ProcessingStatus¶

Status of processing in the engine: could be either success or error. In the case of error, you should check the report and if everything matches the input requirement (UTF8 being the most salient) you should contact Emtelligent.
type	string
enum	success, error

Entity¶

A named entity.
type	object
properties
label	Label for this entity.
	EntityLabel

FoundEntity¶

Entity identified from input that corresponds to text span(s).
allOf	Entity
	type	object
	properties
	entity_type	Type information for this entity.
		EntityType
	attributes	EntityAttributes
	concept_links	List of concepts that match this entity. Can be empty in cases where the entity type of a span of text could be determined but the link to an existing concept in an ontology could not be accomplished, which is either due to a missing synonym for a concept or because the concept does not exist in the chosen ontology or ontologies.
		type	array
		items
			ConceptLabel
	locations	List of text locations that contain this entity.
		type	array
		items
			LocationLabel
	section_name	Name of the document section that this entity was found in.
		SectionName
	spans	Spans of input text that represent this entity.
		type	array
		items
			Span
	text	Parts of input text corresponding to this entity (matches spans). Present when the ‘text’ feature is enabled.
		type	array
		items
			type	string

EntityLabel¶

Entity label, unique within the document.
type	string

EntityType¶

Corresponds to the NER category according to different sources. Each field represents the type according to one source.
type	object
properties
emtelligent	type	string
snomed	type	string
rxnorm	type	string
radlex	type	string
medcin	type	string
umls	type	string
umls_nci	type	string
umls_hgnc	type	string
umls_loinc	type	string
snomed_icd10	type	string
snomed_icd10_cm	type	string
rad_playbook	type	string

EntityAttributes¶

Attributes describing a entity, with each property being one attribute keyed by name.
type	object
properties
polarity	Polarity of this entity. Present if the ‘entity-polarity’ feature is enabled.
	Polarity
uncertainty	Uncertainty of this entity. Present if the ‘entity-uncertainty’ feature is enabled.
	Uncertainty
question_status	Question status of this entity. Present if the ‘entity-question-status’ feature is enabled.
	QuestionStatus
guidance	Captures whether this entity is part of a guidance statement, where someone is suggesting that someone else do something. Say a caregiver writes ‘If the patient experiences abdominal pain, she should return to the ER.’ In this case, ‘abdominal pain’ is not something the patient currently has, but is part of a guidance statement, and thus the value of this attribute for ‘abdominal pain’ would be ‘is_guidance’. If an entity is not part of a guidance statement, it is assigned a value of ‘not_guidance’. Present if the ‘entity-guidance’ feature is enabled.
	Guidance
measurement_unit	The measurement unit that is heuristically extracted out of the measurement entity. The unit string is not normalized to a concept. Present for measurement entities if the ‘entity-measurement-unit’ feature is enabled. When a measurement entity is missing a unit of measurement, the value will be `null`.
	anyOf		type	null
			type	array
			items
				type	string
			minItems	1
known_ambiguity	The ambiguity status of the entity is annotated by an expert to have the value ambiguous if the entity can potentially refer to many different medical concepts; the value unambiguous if the entity refers to a single medical concept; otherwise the ambiguity status is unknown. Present if the ‘entity-known-ambiguity’ feature is enabled.
	type	string
	enum	ambiguous, unambiguous, unknown

AssumedEntity¶

Entity assumed from concept.
allOf	Entity
	type	object
	properties
	value	The value representing this entity. Can be: patient family
		type	string

Concept¶

Concept in an ontology that has been linked to an entity in the input.
type	object
properties
label	Label for this concept.
	ConceptLabel
concept_id	The ID of this concept in the ontology.
	type	string
description	The description of this concept from the ontology.
	type	string

ConceptLabel¶

Entity label, unique within the document.
type	string

Relation¶

A relation that is inferred between entities based on understanding the text.
type	object
properties
attributes	type	object
	properties
label	Label for this relation.
	RelationLabel

FollowupRelation¶

A relation indicating that a follow-up was requested for a certain procedure in an optional timeframe.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
		polarity	Polarity
	args	Arguments for the follow-up relation.
		type	object
		properties
		procedures	type	array
			items
				RelationEntityArg
		time_expression	anyOf		type	null
					RelationEntityArg
		reasons	type	array
			items
				RelationEntityArg

ExperiencerRelation¶

A relation indicating that an entity (could be assumed) is the experiencer of a medical named entity.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
		polarity	Polarity
	args	Arguments for the experiencer relation.
		type	object
		properties
		experiencer	RelationPersonArg
		experienced	RelationEntityArg

MeasurementRelation¶

A relation indicating a measurement of morphological abnormalities or anatomical sites.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
	args	Arguments for the measurement relation.
		type	object
		properties
		subject	anyOf	type	null
				RelationEntityArg
		value	anyOf	type	null
				RelationEntityArg

ImageLinkRelation¶

A relation indicating a reference to an image or image slice, and to findings in that image. There could be multiple images mentioned in this relation and multiple findings associated with one or more images and as result both these arguments are arrays.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
	args	Arguments for the imagelink relation.
		type	object
		properties
		image_findings	type	array
			items
				RelationEntityArg
		references	type	array
			items
				RelationEntityArg

QualifierRelation¶

A relation indicating that a qualifier value of varying types (such as size/severity) is the modifier of a medical named entity.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
		qualifier_type	QualifierType
	args	Arguments for the qualifier relation.
		type	object
		properties
		qualifier	RelationEntityArg
		qualifies	RelationEntityArg

MedicationRelation¶

A relation capturing the various pieces of information associated with a medication prescription.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
	args	allOf		Arguments for the medication relation. Besides the required `drug` argument, at least one other argument value will be present.
				type	object
				properties
				drug	RelationEntityArg
				dosage	type	array
					items
						RelationEntityArg
				route	type	array
					items
						RelationEntityArg
				quantity	type	array
					items
						RelationEntityArg
				mode	type	array
					items
						RelationEntityArg
				frequency	type	array
					items
						RelationEntityArg
				duration	type	array
					items
						RelationEntityArg
				necessity	type	array
					items
						RelationEntityArg
				modifier	type	array
					items
						RelationEntityArg
				indication	type	array
					items
						RelationEntityArg
				date_time	type	array
					items
						RelationEntityArg
				at least one must contain at least 1 item	dosage
					route
					quantity
					mode
					frequency
					duration
					necessity
					modifier
					indication
					date_time

TemporalityRelation¶

A relation indicating whether the `subject` entity is in scope of a `temporal_entity`. Currently the only supported categories of temporality are `historical` and `specific`. The `historical` category indicates that the subject entity (like `heart disease`) is within the scope of a historical `temporal_entity` (like `history of`) in the sentence `history of heart disease`. In some cases, the `temporal_entity` is not a `FoundEntity` but rather an `AssumedEntity` by virtue of occurring within a section categorized as historical e.g. `Family History:`. The `specific` category indicates that the subject entity (like `diabetes`) is within the scope of a specific time, date, or date range (`since 1982`) in the sentence `He has had diabetes since 1982`. The `polarity` attribute for this relation indicates whether the temporality status itself is negated or asserted.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
		polarity	Polarity
		category	type	string
			enum	historical, specific
	args	type	object
		properties
		temporal_entity	RelationEntityArg
		subject	RelationEntityArg
		modifiers	type	array
			items
				RelationEntityArg

ReportedEventRelation¶

A relation capturing the notion of a communication between two groups of entities. Currently the only supported `category` of this relation is `critical_results`, which indicates that critical results about a important diagnosis are recorded as having been communicated.
allOf	Relation
	type	object
	properties
	attributes	type	object
		properties
		polarity	Polarity
		category	type	string
			enum	critical_results
	args	type	object
		properties
		subject	The subject of the communication.
			RelationEntityArg
		to_entities	Recipients of the communication.
			type	array
			items
				RelationEntityArg
		from_entities	Sources of the communication.
			type	array
			items
				RelationEntityArg
		methods	The methods of communication, such as in person or by telephone.
			type	array
			items
				RelationEntityArg
		time_expressions	Time expressions that indicate when the communication took place.
			type	array
			items
				RelationEntityArg

RelationLabel¶

Relation label, unique within the document.
type	string

RelationPersonArg¶

Argument of a relation refering to a person.
type	object
properties
ref	Label for the named entity for person(s).
	EntityLabel
text	Parts of the input text representing this argument. Present when the ‘text’ feature is enabled.
	type	array
	items
		type	string

RelationEntityArg¶

Argument of a relation refering to an entity.
type	object
properties
ref	Label for the named entity used as an argument to a relation.
	EntityLabel
text	Parts of the input text representing this argument. Present when the ‘text’ feature is enabled.
	type	array
	items
		type	string

Location¶

A part of the input text.
type	object
properties
label	Identifier for this location, unique within the submission results.
	LocationLabel

SentenceLocation¶

A location indicating a sentence.
allOf	Location
	type	object
	properties
	spans	The spans into the input text that make up this location.
		type	array
		items
			Span
	text	The parts input text corresponding to the spans. Present when the ‘text’ feature is enabled.
		type	array
		items
			type	string
	sections	All sections that contain this sentence.
		type	array
		items
			LocationLabel

SectionLocation¶

A location indicating a section of a document. For example a ‘Subjective’ section may have ‘Problem’ and ‘Nutrition’ sub-sections. In this example ‘Subjective’ will have level 0 and null parent, while ‘Problem’ and ‘Nutrition’ will both have level 1 and their parents will point to the ‘Subjective’ section.
allOf	Location
	type	object
	properties
	spans	The spans into the input text that make up this location.
		type	array
		items
			Span
	text	The parts input text corresponding to the spans. Present when the ‘text’ feature is enabled.
		type	array
		items
			type	string
	name	Name of this section.
		SectionName
	level	The level of this section: 0 for outer-most sections, 1 for their subsections, etc..
		type	integer
	parent	The parent section that contains this sub-section, or null if this is an outer-most section.
		anyOf		type	null
				LocationLabel

LocationLabel¶

Identifier for a location in the document.
type	string

SectionName¶

The name of a section within a document, eg ‘INTRO’, ‘IMPRESSION’, ‘Family History’ or ‘FINDINGS’.
type	string

Polarity¶

Specifies if the entity is within the scope of negation. An entity can either be asserted or negated.
type	string
enum	asserted, negated

Uncertainty¶

Specifies if the entity is within the scope of a hedge or uncertainty indicator (e.g. ‘might be’). An entity can either be certain or uncertain.
type	string
enum	certain, uncertain

QuestionStatus¶

Specifies if the entity is within the scope of a question that is posed in a medical context (e.g. ‘rule out’ or ‘assess’). An entity can either be is_question or not_question.
type	string
enum	is_question, not_question

Guidance¶

Specifies if an entity is part of a guidance statement.
type	string
enum	is_guidance, not_guidance

MeasurementUnit¶

Unit for a measurement.
type	string

QualifierType¶

Specifies the type of a qualifier relation. This indicates the interpretation of the qualifier value (the qualifier arg) and how it modifies a medical named entity (the qualifies arg).
type	string
enum	duration/time, size/severity, status, stage/grade, compliance, location, unknown

Span¶

A span into text.
type	object
properties
end	Ending index.
	type	integer
start	Starting index.
	type	integer

OntologyVersionInfo¶

Version information for one ontology. May have various extra fields depending on the available information.
type	object
properties
release_version	The version string from the official release of the ontology.
	type	string
additionalProperties	type	string