Skip to main content

cimi.element

The Element Package defines reusable data elements that are used across multiple packages.

AnatomicalDirection

Anatomical location or specimen further detailing directionality. C99074

Value:  CodeableConcept must be from AnatomicalDirectionVS
A set of codes drawn from different coding systems, representing the same concept.

AnatomicalLocation

A location or structure in the body, including tissues, regions, cavities, and spaces; for example, right elbow, or left ventricle of the heart. C1545955

Value:  CodeableConcept must be from AnatomicalLocationVS
A set of codes drawn from different coding systems, representing the same concept.
Laterality optional Anatomical location or specimen further detailing the side(s) of interest.
AnatomicalDirection optional Anatomical location or specimen further detailing directionality.

Annotation

An added or follow-up note, often after the fact, that contains metadata about who made the statement and when.

Value:  string
Author required The person or organization who created the entry and is responsible for (and may certify) the content.
OccurrenceTime required The point in time in which something happens.

Author

The person or organization who created the entry and is responsible for (and may certify) the content.

Value:  Choice required
         |  string
         |  Patient A person in the role of a patient, including extended demographic information about the subject of this health record.
         |  Group A set of entities (personnel, material, or places) to be considered together. May be a pool of like-type resources, a team, or combination of personnel, material and places.
         |  Device A specific durable physical device used in diagnosis or treatment. The value is the coding for a type of device, for example, a CPAP machine. The same device might be used on multiple patients.
         |  RelatedPerson A person in a role defined in relationship to a patient
         |  Organization A social or legal structure formed by human beings.

FamilyName

The portion of a person's name that reflects the genealogy of the person. In western cultures, this is the 'last' name. In eastern cultures, the family name appears before the person's given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. (Source: HL7 V3). 45394-4

Value:  string

GivenName

The person's given name - e.g., John 45392-8 408677003

Value:  string

Identifier

A unique string that identifies a specific person or thing. C0600091

Value:  string
Purpose must be from http://hl7.org/fhir/ValueSet/identifier-use
optional Why the item is used.
Type from http://hl7.org/fhir/ValueSet/identifier-type
(if covered)
optional The most specific code (lowest level term) describing the kind or sort of thing being represented.
CodeSystem optional A formal terminology system.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.
Issuer optional An organization who issues a qualification, identifier, or license.

Issuer

An organization who issues a qualification, identifier, or license.

Value:  Organization A social or legal structure formed by human beings.

Laterality

Anatomical location or specimen further detailing the side(s) of interest. Anatomical laterality (C0925205)

Value:  CodeableConcept must be from http://hl7.org/fhir/ValueSet/bodysite-laterality
A set of codes drawn from different coding systems, representing the same concept.

Match

The relative match of the mapped concept to the original (target) concept. Examples include broader (i.e., the mapped term is more general than the original), equivalent, narrower (e.g. mapped concept is 'atypical diabetes mellitus' and the original term is 'diabetes mellitus'), or unknown.

Value:  Coding Coding of a concept, drawn from a controlled vocabulary. Includes the vocabulary and version, if applicable. May include a display text, and a descriptor expressing the intended interpretation of the code.

MiddleName

The person's middle name. 45392-8 408677003

Value:  string

Name

Abstract supertype for the name of an entity.

NameAsText optional The name as plain unstructured or semi-structured text.
Purpose 0 or more Why the item is used.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

NameAsText

The name as plain unstructured or semi-structured text.

Value:  string

OnBehalfOf

The party represented by the actual participant.

Value:  Choice required
         |  uri
         |  Organization A social or legal structure formed by human beings.

PartOf

The larger entity that this is a portion of. For example, an organization might be part of a larger organization, or an encounter with a hospitalist might be part of a larger hospitalization encounter.

Value:  Independent Base class for classes in CIMI that include enough context to stand alone. Analogous to FHIR's DomainResource.

PersonName

A name used by a human being, written as it would be typically expressed. May include a breakdown of the various elements of the name (family name, given name, etc.). C1547383

Based On Name

PreferredFlag optional Code indicating the preference associated with the use of this name.
Prefix 0 or more Contains a set of honorific terms that typically appear before a person's name, for example Mr., Mrs., Dr., etc.
GivenName 0 or more The person's given name - e.g., John
MiddleName 0 or more The person's middle name.
FamilyName 0 or more The portion of a person's name that reflects the genealogy of the person. In western cultures, this is the 'last' name. In eastern cultures, the family name appears before the person's given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. (Source: HL7 V3).
Suffix 0 or more Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Purpose must be from http://hl7.org/fhir/ValueSet/name-use
optional Why the item is used.
NameAsText optional The name as plain unstructured or semi-structured text.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

PreferredFlag

Code indicating the preference associated with the use of this name.

Value:  CodeableConcept A set of codes drawn from different coding systems, representing the same concept.

Prefix

Contains a set of honorific terms that typically appear before a person's name, for example Mr., Mrs., Dr., etc. C3476361

Value:  string

RouteIntoBody

The way a substance enters an organism after contact, particularly, the route of drug administration. C0013153

Value:  CodeableConcept must be from http://hl7.org/fhir/ValueSet/route-codes
A set of codes drawn from different coding systems, representing the same concept.

Signatory

The party signing.

Value:  Choice required
         |  uri
         |  Entity Root class for entities such as people, organizations, and devices that have a separately identifiable existence.

Signature

A digital Signature - XML DigSig, JWT, Graphical image of signature, etc.

SignatureType from http://hl7.org/fhir/ValueSet/signature-type
(if covered)
1 or more Type of signature
CreationTime required The point in time when the information was recorded in the system of record.
Signatory required The party signing.
OnBehalfOf optional The party represented by the actual participant.
ContentType optional Mime type of the content, with charset etc.
BinaryData optional The data itself.

SignatureType

Type of signature C0332307

Value:  Coding Coding of a concept, drawn from a controlled vocabulary. Includes the vocabulary and version, if applicable. May include a display text, and a descriptor expressing the intended interpretation of the code.

Status

The current standing or state. C0449438

Value:  Choice required
         |  code
         |  Coding Coding of a concept, drawn from a controlled vocabulary. Includes the vocabulary and version, if applicable. May include a display text, and a descriptor expressing the intended interpretation of the code.
         |  CodeableConcept A set of codes drawn from different coding systems, representing the same concept.

Suffix

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. 45395-1 715196001

Value:  string

TermMapping

Represents an alternative (mapped) Concept associated with a source concept (i.e., CodedText.concept or the textual value of the CodedText when no equivalent concept has been defined), and the relative match of the mapped Concept with respect to the source Concept. Mappings may be used to add classification terms (e.g. adding ICD classifiers to SNOMED descriptive terms), for computational convenience, or to provide equivalents in other terminologies (e.g. across nursing vocabularies).

Value:  Coding Coding of a concept, drawn from a controlled vocabulary. Includes the vocabulary and version, if applicable. May include a display text, and a descriptor expressing the intended interpretation of the code.
Match required The relative match of the mapped concept to the original (target) concept. Examples include broader (i.e., the mapped term is more general than the original), equivalent, narrower (e.g. mapped concept is 'atypical diabetes mellitus' and the original term is 'diabetes mellitus'), or unknown.
Purpose optional Why the item is used.