Skip to main content

Core

The SHR Core domain contains definitions for a variety of general-purpose elements that are used widely in SHR. These include definitions for coding, expressions of time, quantities, addresses, names, and more.

Address

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR).

AddressLine 0 - 2 Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR).
City optional The name of a city, town, village or other community or delivery center. (Source: HL7 FHIR).
County optional The name of the administrative area at a level below that of a state but above that of a city or town. Outside the US, a district or the equivalent. (Source: HL7 FHIR).
State optional Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR).
PostalCode optional A postal code designating a region defined by the postal service.
Country required Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes.

AddressLine

Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR).

Value:  string

Age

How long something has existed (quantitative). C0001779

Based On Duration

Value:  decimal
Units must be from TimeUnitOfMeasureVS required Code for the unit of measure of the quantity.

AgeGroup

Subgroups of populations based on age. C0027362

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

AgeRange

A quantitative range of ages. One of the two ages must be specified.

Based On Range

LowerBound optional A measured or measurable amount with units that is known to be bounded from below by the quantity represented.
UpperBound optional A measured or measurable amount with units that is known to be bounded from above by the quantity represented.

Altitude

Height above sea level or above the earth's surface. Measured with with WGS84 datum. C0002349

Value:  decimal

Annotation

A text note which also contains information 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) its content.
OccurrenceTime required The point in time or span of time in which something happens.

Area

The extent of a 2-dimensional surface enclosed within a boundary. C0205146

Value:  Quantity Units is TBD A quantity with units.

BodyPosition

The position or physical attitude of the body. C1262869

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

BodySite

A location 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 BodySiteVS 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.
Directionality optional Anatomical location or specimen further detailing directionality.
PortionTotality optional ObservationQualifier for anatomical location or specimen further detailing the portion or totality, which means arrangement of, or apportioning of an entity.
ClockDirection optional A direction indicated by an angle relative to 12 o'clock.
Distance optional The space separating two objects or points.
Description optional An account, representation, statement, or explanation of something.
BodySiteMarker optional A marker surgically placed at the site, often during a biopsy procedure, to pinpoint the location. The marker is typically a metal clip or radioactive seed.

BodySiteMarker

A marker surgically placed at the site, often during a biopsy procedure, to pinpoint the location. The marker is typically a metal clip or radioactive seed.

Value:  string

Certainty

The degree of confidence in a conclusion or assertion.

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

Circumference

The length of such a boundary line of a figure, area, or object. C0332520

City

The name of a city, town, village or other community or delivery center. (Source: HL7 FHIR). C1555315

Value:  string

ClockDirection

A direction indicated by an angle relative to 12 o'clock. 72294-2

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

CodeableConcept

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

Coding 0 or more 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.
DisplayText optional A string meant for reading by a person, usually accompanying a code.

CodeSystem

A formal terminology system.

Value:  uri

CodeSystemVersion

The version of the vocabulary being used, if applicable.

Value:  string

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. C0805701

Value:  code
CodeSystem optional A formal terminology system.
CodeSystemVersion optional The version of the vocabulary being used, if applicable.
DisplayText optional A string meant for reading by a person, usually accompanying a code.

Comment

A critical or explanatory note written to discuss, support, explain changes to, or dispute information. C0947611

Value:  string

Count

The number of non-null items in a referenced set of items or values. C0750480

Value:  positiveInt

Country

Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes. C0454664

Value:  string

County

The name of the administrative area at a level below that of a state but above that of a city or town. Outside the US, a district or the equivalent. (Source: HL7 FHIR). C0079170

Value:  string

Denominator

The divisor of a fraction. C2825218

Value:  Quantity A quantity with units.

Depth

The extent downward or inward; the perpendicular measurement from the surface downward to determine deepness. C0205125

Value:  Quantity Units is TBD A quantity with units.

Description

An account, representation, statement, or explanation of something. C0678257

Value:  string

Details

Particulars considered individually and in relation to a whole. C1522508

Value:  string

Directionality

Anatomical location or specimen further detailing directionality. C99074

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

DisplayText

A string meant for reading by a person, usually accompanying a code. C1548311

Value:  string

Distance

The space separating two objects or points. C0012751

Value:  Quantity Units is TBD A quantity with units.

DollarAmount

An amount of money expressed in US dollars. C0562019

Based On Quantity

Value:  decimal
Units is USD required Code for the unit of measure of the quantity.

Duration

The length of time that something continues. C0449238

Based On Quantity

Value:  decimal
Units must be from TimeUnitOfMeasureVS required Code for the unit of measure of the quantity.

EffectiveDate

The date when something is to take effect. C1301880

Value:  date

EffectiveTimePeriod

The date and time span for which something is active, valid, or in force. C2985763

Based On TimePeriod

TimePeriodStart required The time at which something is to take effect, start, or did start.
TimePeriodEnd optional The time at which something is to end or did end.

Explanation

A set of statements describing a group of facts that clarifies the cause, context and/or consequence of those facts. C0681841

Value:  string

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

Frequency

How many occurrences of an event per unit of time. C0376249

Count required The number of non-null items in a referenced set of items or values.
Duration required The length of time that something continues.

GeneralizedAge

Qualitative or quantitative, exact or inexact description of age.

Value:  Choice
         |  Age required How long something has existed (quantitative).
         |  AgeRange required A quantitative range of ages. One of the two ages must be specified.
         |  AgeGroup required Subgroups of populations based on age.

GeneralizedDateTime

A point in time, specified qualitatively or quantitatively.

Value:  Choice
         |  dateTime required
         |  TimePeriod required A period of time defined by a start and end time, date, or year.
         |  QualitativeDateTime required A point in time, described qualitatively.

GeneralizedDuration

The duration of an event, qualitatively or quantitatively.

Value:  Choice
         |  Duration required The length of time that something continues.
         |  SemiquantDuration required The duration of an event, described semi-quantitatively.

GeneralizedFrequency

The frequency of an event, qualitatively or quantitatively.

Value:  Choice
         |  Frequency required How many occurrences of an event per unit of time.
         |  SemiquantFrequency required The frequency of an event, described semi-quantitatively.
         |  QualitativeFrequency required The frequency of an event, described qualitatively.

GeneralizedLikelihood

Quantitative or qualitative measure of likelihood.

Value:  Choice
         |  Likelihood required A measure of the expectation of the occurrence of a particular event, as a percentage.
         |  QualitativeLikelihood required A qualitative (subjective) likelihood.

GeneralizedTemporalContext

A generalized indicator of a dateTime or an age when an event happened.

Value:  Choice
         |  GeneralizedDateTime required A point in time, specified qualitatively or quantitatively.
         |  GeneralizedAge required Qualitative or quantitative, exact or inexact description of age.
         |  GestationalTemporalContext required A named gestational time period, or a gestational age.

GeopoliticalLocation

The countries of the world and major geopolitical subregions, such as US states. C0017446

Based On Address

AddressLine not used Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR).
PostalCode not used A postal code designating a region defined by the postal service.
City optional The name of a city, town, village or other community or delivery center. (Source: HL7 FHIR).
County optional The name of the administrative area at a level below that of a state but above that of a city or town. Outside the US, a district or the equivalent. (Source: HL7 FHIR).
State optional Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR).
Country required Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes.

Geoposition

The location on the surface of the Earth, described by a latitude and longitude (and optional altitude).

Latitude required The angular distance north or south between an imaginary line around a heavenly body parallel to its equator and the equator itself. Measured with with WGS84 datum.
Longitude required An imaginary great circle on the surface of a heavenly body passing through the poles at right angles to the equator. Measured with with WGS84 datum.
Altitude optional Height above sea level or above the earth's surface. Measured with with WGS84 datum.

GestationalAge

The age of the embryo or fetus. This may be assessed by medical history, physical examination, early immunologic pregnancy tests, radiography, ultrasonography, and amniotic fluid analysis. C0017504

Value:  Age How long something has existed (quantitative).

GestationalTemporalContext

A named gestational time period, or a gestational age.

Value:  Choice
         |  GestationalAge required The age of the embryo or fetus. This may be assessed by medical history, physical examination, early immunologic pregnancy tests, radiography, ultrasonography, and amniotic fluid analysis.
         |  GestationalTimePeriod required A time relative to a pregnancy or childbirth event.

GestationalTimePeriod

A time relative to a pregnancy or childbirth event.

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

GivenName

A set of names given to a person at birth, but not including the family name. In western cultures, this property would contain the 'first' and 'middle' names. Note that in some cultures, the given name is placed after the family name. Note also that this property contains multiple elements, so it can handle those situations where a person has more than one 'middle' name. (Source: HL7 V3). 45392-8 408677003

Value:  string

HumanName

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

Value:  string
HumanNamePrefix optional Contains a set of honorific terms that typically appear before a person's name, for example Mr., Mrs., Dr., etc. Prefixes have a strong association to the immediately following name part. (Source: HL7 V3).
GivenName 0 or more A set of names given to a person at birth, but not including the family name. In western cultures, this property would contain the 'first' and 'middle' names. Note that in some cultures, the given name is placed after the family name. Note also that this property contains multiple elements, so it can handle those situations where a person has more than one 'middle' name. (Source: HL7 V3).
FamilyName optional 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).
HumanNameSuffix 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.
HumanNameUse optional A qualifier specifying how a human name is used by a person, such as a legal name, alias, or nickname.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

HumanNamePrefix

Contains a set of honorific terms that typically appear before a person's name, for example Mr., Mrs., Dr., etc. Prefixes have a strong association to the immediately following name part. (Source: HL7 V3). C3476361

Value:  string

HumanNameSuffix

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

HumanNameUse

A qualifier specifying how a human name is used by a person, such as a legal name, alias, or nickname.

Value:  code must be from http://hl7.org/fhir/ValueSet/name-use

Identifier

A unique string that identifies a specific person or thing.

Value:  string

Laterality

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

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

Latitude

The angular distance north or south between an imaginary line around a heavenly body parallel to its equator and the equator itself. Measured with with WGS84 datum. C1627936

Value:  decimal

Length

The measurement or linear extent of something from end to end; the greatest dimensions of a body. C1444754

Value:  Quantity Units is TBD A quantity with units.

Likelihood

A measure of the expectation of the occurrence of a particular event, as a percentage. C0033204

Value:  positiveInt

Location

A position, site, or point in space where something can be found. C0450429

Value:  Choice
         |  Address required An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR).
         |  Geoposition required The location on the surface of the Earth, described by a latitude and longitude (and optional altitude).
         |  GeopoliticalLocation required The countries of the world and major geopolitical subregions, such as US states.

Longitude

An imaginary great circle on the surface of a heavenly body passing through the poles at right angles to the equator. Measured with with WGS84 datum. C1657623

Value:  decimal

LowerBound

A measured or measurable amount with units that is known to be bounded from below by the quantity represented.

Based On Quantity

Value:  decimal
LowerBoundType required Indicates the actual value is gt (>) or gte (>=) the given value.
Units optional Code for the unit of measure of the quantity.

LowerBoundType

Indicates the actual value is gt (>) or gte (>=) the given value.

Value:  code must be from LowerBoundTypeVS

Numerator

The dividend of a fraction. C2825219

Value:  Quantity A quantity with units.

OccurrenceTime

The point in time or span of time in which something happens.

Value:  Choice
         |  dateTime required
         |  date required
         |  TimePeriod required A period of time defined by a start and end time, date, or year.

OrganizationalIdentifier

Unique identifier of something or someone, assigned by an organization, and potentially effective for only a limited time period.

Based On Identifier

Value:  string
TimePeriod optional A period of time defined by a start and end time, date, or year.
Organization optional A social or legal structure formed by human beings.

Percentage

A percentage value where 100.0 represents 100%. C0439165

Value:  Quantity Units is % A quantity with units.

PeriodOfUse

A period of time when a device, medication, or other therapy is used.

Based On TimePeriod

TimePeriodStart required The time at which something is to take effect, start, or did start.
TimePeriodEnd optional The time at which something is to end or did end.

PortionTotality

ObservationQualifier for anatomical location or specimen further detailing the portion or totality, which means arrangement of, or apportioning of an entity. C99075

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

PostalCode

A postal code designating a region defined by the postal service. C1514254

Value:  string

Priority

An ordinal numbered priority where 1=highest priority, 2=second highest priority, etc. C0549179

Value:  positiveInt

QualitativeDateTime

A point in time, described qualitatively.

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

QualitativeFrequency

The frequency of an event, described qualitatively.

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

QualitativeLikelihood

A qualitative (subjective) likelihood.

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

Quantity

A quantity with units.

Value:  decimal
Units optional Code for the unit of measure of the quantity.

Range

An interval defined by an upper and/or lower bound. One of the two bounds must be specified, and the lower bound must be less than the upper bound.

LowerBound optional A measured or measurable amount with units that is known to be bounded from below by the quantity represented.
UpperBound optional A measured or measurable amount with units that is known to be bounded from above by the quantity represented.

Ratio

A unit of measurement for the quotient of the amount of one entity to another. C0456603

Numerator required The dividend of a fraction.
Denominator required The divisor of a fraction.

Reason

The justification for an action or non-action, conclusion, opinion, etc. C0566251

Value:  Choice
         |  string required
         |  CodeableConcept required A set of codes drawn from different coding systems, representing the same concept.
         |  Condition required A representation of a disorder, abnormality, problem, injury, complaint, risk, functionality, concern, illness, disease, ailment, sickness, affliction, upset, difficulty, disorder, symptom, worry, or trouble. Condition can be used to track a problem or a risk over a period of time. By virtue of its continuity over time, Condition is different from an Observation or Assessment; Observations represents evidence, and an Assessment is a judgment based on evidence and rendered at a point in time. Diagnosis is a type of Assessment that can lead to creation of a Condition (as can an assessment of risk). The two relate because observations can lead to conclusion that a Condition exists. A statement that a certain condition does not exist should be an assessment. Not all conditions are problems, but all problems are (in some sense) conditions.

SemiquantDuration

The duration of an event, described semi-quantitatively.

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

SemiquantFrequency

The frequency of an event, described semi-quantitatively.

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

Setting

Description of the place or type of surroundings where something is positioned or where an event takes place.

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

SpecificType

A code or description representing the concept represented by the instance at a specific level. For example, for a Condition, the concept is MTH#C0348080 (Condition) but the Value is the SpecificType, i.e. MTH#C0011849 (Diabetes Mellitus). For an observation, the SpecificType defines what is being observed, measured, or asked, as specifically as possible. The SpecificType should always align with the concept of the element, for example, a blood pressure observation can be coded as a sitting blood pressure or standing blood pressure, and may be from a different code system (e.g. LOINC versus MTH). In other cases, the SpecificType is the specific question being asked, or the specific goal being pursued.

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

State

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR). C1552743

Value:  string

Statistic

A quantity that represents a statistic, e.g. maximum, minimum, mean, median, etc. C2828391

Based On Quantity

Value:  decimal
StatisticType required The type of statistic that is represented by the value.
Units optional Code for the unit of measure of the quantity.

StatisticType

The type of statistic that is represented by the value.

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

Substance

Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical. C0439861

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

Summary

A shortened version of an item of information, containing only the main points. C1706244

Value:  string

TimePeriod

A period of time defined by a start and end time, date, or year. C1948053

TimePeriodStart required The time at which something is to take effect, start, or did start.
TimePeriodEnd optional The time at which something is to end or did end.

TimePeriodEnd

The time at which something is to end or did end. C1522314

Value:  Choice
         |  dateTime required
         |  date required

TimePeriodStart

The time at which something is to take effect, start, or did start. C1301880

Value:  Choice
         |  dateTime required
         |  date required

Title

A distinguishing word or group of words naming an item.

Value:  string

UnitedStatesAddress

An address for a place in the USA, conforming to US mail postal conventions. (Source: HL7 FHIR).

Based On Address

State must be a UnitedStatesState required Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR).
Country required Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes.
AddressLine 0 - 2 Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR).
City optional The name of a city, town, village or other community or delivery center. (Source: HL7 FHIR).
County optional The name of the administrative area at a level below that of a state but above that of a city or town. Outside the US, a district or the equivalent. (Source: HL7 FHIR).
PostalCode optional A postal code designating a region defined by the postal service.

UnitedStatesState

A state or territory in the USA expressed by 2-letter US Postal code. C3148680

Based On State

Value:  string

Units

Code for the unit of measure of the quantity.

Value:  Coding must be from http://hl7.org/fhir/ValueSet/ucum-units 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.

UpperBound

A measured or measurable amount with units that is known to be bounded from above by the quantity represented.

Based On Quantity

Value:  decimal
UpperBoundType required Indicates the actual value is lt (<) or lte (<=) the given value.
Units optional Code for the unit of measure of the quantity.

UpperBoundType

Indicates the actual value is lt (<) or lte (<=) the given value.

Value:  code must be from UpperBoundTypeVS

Version

A string identifying the particular of form of something (such as a code system or software product) that is different in some way from another form of the same thing. C0333052

Value:  id

Volume

The amount of three dimensional space occupied by an object or the capacity of a space or container. C0449468

Value:  Quantity Units is TBD A quantity with units.

Width

The measurement or extent of something from side to side. C0487742

Value:  Quantity Units is TBD A quantity with units.