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). C0682130

Purpose must be from http://hl7.org/fhir/ValueSet/address-use optional Describes how the item is (or was) used or applied.
Type must be from http://hl7.org/fhir/ValueSet/address-type optional The most specific code (lowest level term) describing the kind or sort of thing being represented.
DisplayText optional A string meant for reading by a person, for example, accompanying a code.
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 municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR).
District optional The name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. 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 sequence of letters and digits used as part of a postal address, often designating a geographic region
Country required Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

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 in time. C0001779

Based On Quantity

Value:  decimal
Units must be from http://hl7.org/fhir/ValueSet/units-of-time optional Code for the unit of measure of the quantity.
Comparator optional

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.

UpperBound must be a Age optional The upper limit on a quantitative value.
LowerBound must be a Age optional The lower limit on a range

Altitude

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

Value:  decimal

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.

Area

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

Based On ObservationComponent

Value:  Quantity Units is TBD A quantity with units, whose value may be bounded from above or below, as defined in FHIR
ValueAbsentReason optional Provides a reason why the value of the observation is missing, if it is expected (some observations are not expected to have a value).
ObservationCode required A code that represents what the finding concerns, for example, the subject's height, blood pressure, disease status, wound dimensions, diabetes risk, etc. Although named ObservationCode, in different contexts the same attribute might be more naturally referred to as a property, observable, or test code. In assertions (observations without an explicit question), the observation code is defaulted to a value representing 'assertion'.
Interpretation optional A clinical interpretation of a finding.
ReferenceRange 0 or more The usual or acceptable range for a test result.
Components optional Components are parts of the parent observation. Component observations share the same attributes (such as Specimen) as the primary observation and are not separable. However, the reference range may be different for each component observation.

Attachment

A file that contains audio, video, image, or similar content.

Based On EmbeddedContent

BinaryData optional The data itself.
ContentType optional Mime type of the content, with charset etc.
Language optional A human language, spoken or written.
ResourceLocation optional URI where data can be found.
ResourceSize optional Number of bytes of content in the resource (if url provided)
Hash optional A hash code of the data (sha-1, base64ed)
Title optional A distinguishing word or group of words naming an item.
CreationTime optional The point in time when the information was recorded in the system of record.

BinaryData

The data itself.

Value:  base64Binary

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.

Category

A class or division of people or things having particular shared characteristics

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

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

Based On ObservationComponent

Value:  Choice
         |  Quantity required A quantity with units, whose value may be bounded from above or below, as defined in FHIR
         |  CodeableConcept required A set of codes drawn from different coding systems, representing the same concept.
         |  string required
         |  Range required An interval defined by a quantitative upper and/or lower bound. One of the two bounds must be specified, and the lower bound must be less than the upper bound. When Quantities are specified, the units of measure must be the same.
         |  Ratio required A unit of measurement for the quotient of the amount of one entity to another.
         |  Attachment required A file that contains audio, video, image, or similar content.
         |  time required
         |  dateTime required
         |  TimePeriod required A period of time defined by a start and end time, date, or year. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.
         |  IntegerQuantity required A Quantity that is an integer.
ValueAbsentReason optional Provides a reason why the value of the observation is missing, if it is expected (some observations are not expected to have a value).
ObservationCode required A code that represents what the finding concerns, for example, the subject's height, blood pressure, disease status, wound dimensions, diabetes risk, etc. Although named ObservationCode, in different contexts the same attribute might be more naturally referred to as a property, observable, or test code. In assertions (observations without an explicit question), the observation code is defaulted to a value representing 'assertion'.
Interpretation optional A clinical interpretation of a finding.
ReferenceRange 0 or more The usual or acceptable range for a test result.
Components optional Components are parts of the parent observation. Component observations share the same attributes (such as Specimen) as the primary observation and are not separable. However, the reference range may be different for each component observation.

City

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

Based On GeopoliticalLocation

Value:  string

ClockDirection

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

Based On ObservationComponent

Value:  CodeableConcept must be from ClockDirectionVS A set of codes drawn from different coding systems, representing the same concept.
ValueAbsentReason optional Provides a reason why the value of the observation is missing, if it is expected (some observations are not expected to have a value).
ObservationCode required A code that represents what the finding concerns, for example, the subject's height, blood pressure, disease status, wound dimensions, diabetes risk, etc. Although named ObservationCode, in different contexts the same attribute might be more naturally referred to as a property, observable, or test code. In assertions (observations without an explicit question), the observation code is defaulted to a value representing 'assertion'.
Interpretation optional A clinical interpretation of a finding.
ReferenceRange 0 or more The usual or acceptable range for a test result.
Components optional Components are parts of the parent observation. Component observations share the same attributes (such as Specimen) as the primary observation and are not separable. However, the reference range may be different for each component observation.

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, for example, 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, for example, accompanying a code.

Comparator

No Description

Value:  code must be from http://hl7.org/fhir/ValueSet/quantity-comparator

ContactDetail

Describes an individual and how to reach them.

HumanName optional 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.).
ContactPoint 0 or more An electronic means of contacting an organization or individual.

ContactPoint

An electronic means of contacting an organization or individual. C2986441

TelecomNumberOrAddress required A user name or other identifier on a telecommunication network, such as a telephone number (including country code and extension, if necessary), email address, or SkypeID.
Type must be from http://hl7.org/fhir/ValueSet/contact-point-system required The most specific code (lowest level term) describing the kind or sort of thing being represented.
Purpose must be from http://hl7.org/fhir/ValueSet/contact-point-use optional Describes how the item is (or was) used or applied.
Priority optional An indication of the importance of an action.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

ContentType

Mime type of the content, with charset etc.

Value:  code

CorrectionFactor

A correction factor that is applied to the sampled data points before they are added to the origin.

Value:  decimal

Count

The number of items (0 or more), as an integer. C0750480

Value:  unsignedInt

CountPerInterval

How many times the event should take place during one recurrence interval, for example, to specify 3-4 times per day, the CountPerInterval should be 3 to 4.

MinCount optional Lower bound on a count.
MaxCount optional Upper bound on a count.

Country

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

Based On GeopoliticalLocation

Value:  string

CreationTime

The point in time when the information was recorded in the system of record. C3669169

Value:  dateTime

DailyLifeEvent

A quotidian landmark, such as rising, mealtime, or bedtime, when an event should take place.

Value:  code must be from http://hl7.org/fhir/ValueSet/event-timing

DayOfWeek

A day of the week that the pattern should take place.

Value:  code must be from http://hl7.org/fhir/ValueSet/days-of-week

Definitional

An indicator that the item is a description of a thing, not a thing that actually exists. For example, a group of people between ages 30 and 40 with Type II diabetes can be defined, without existing as a set of particular people. C1704788

Value:  boolean

Denominator

The divisor of a fraction. C2825218

Value:  Quantity A quantity with units, whose value may be bounded from above or below, as defined in FHIR

Depth

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

Based On ObservationComponent

Value:  Quantity Units is TBD A quantity with units, whose value may be bounded from above or below, as defined in FHIR
ValueAbsentReason optional Provides a reason why the value of the observation is missing, if it is expected (some observations are not expected to have a value).
ObservationCode required A code that represents what the finding concerns, for example, the subject's height, blood pressure, disease status, wound dimensions, diabetes risk, etc. Although named ObservationCode, in different contexts the same attribute might be more naturally referred to as a property, observable, or test code. In assertions (observations without an explicit question), the observation code is defaulted to a value representing 'assertion'.
Interpretation optional A clinical interpretation of a finding.
ReferenceRange 0 or more The usual or acceptable range for a test result.
Components optional Components are parts of the parent observation. Component observations share the same attributes (such as Specimen) as the primary observation and are not separable. However, the reference range may be different for each component observation.

Details

An text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information. C0947611

Value:  string

Dimensions

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

Value:  positiveInt

DisplayText

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

Value:  string

Distance

The measure of space separating two objects or points. C0012751

Based On Quantity

Value:  decimal
Units must be from UnitsOfLengthVS optional Code for the unit of measure of the quantity.
Comparator optional

District

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

Based On GeopoliticalLocation

Value:  string

Duration

The length of time that something continues. C0449238

Based On Quantity

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

DurationRange

A range of durations.

LowerBound must be a Duration optional The lower limit on a range
UpperBound must be a Duration optional The upper limit on a quantitative value.

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 optional The time at which something is to take effect, start, or did start. Boundary is considered inclusive.
TimePeriodEnd optional The time at which something is to end or did end. Boundary is considered inclusive.

EmbeddedContent

Abstract class defining the common metadata of all types of encapsulated data, such as images.

EventDuration

The length of the recurring event.

Value:  DurationRange A range of durations.

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

Formalism

The system of formal syntax or interpretation associated with parsable content.

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

Frequency

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

Based On Ratio

Numerator Units is 1 required The dividend of a fraction.
         where  Units . Coding Units is 1 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.
Denominator required The divisor of a fraction.

GeneralizedAge

Qualitative or quantitative, exact or inexact description of age.

Value:  Choice
         |  Age required How long something has existed in time.
         |  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. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.
         |  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

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

Based On Age

Value:  decimal
Units must be from http://hl7.org/fhir/ValueSet/units-of-time optional Code for the unit of measure of the quantity.
Comparator optional

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. Also note 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

Hash

A hash code of the data (sha-1, base64ed)

Value:  base64Binary

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. Also note 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.
Purpose must be from http://hl7.org/fhir/ValueSet/name-use optional Describes how the item is (or was) used or applied.
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

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 Describes how the item is (or was) used or applied.
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.

IntegerQuantity

A Quantity that is an integer.

Based On Quantity

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

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

Based On ObservationComponent

Value:  Quantity Units is TBD A quantity with units, whose value may be bounded from above or below, as defined in FHIR
ValueAbsentReason optional Provides a reason why the value of the observation is missing, if it is expected (some observations are not expected to have a value).
ObservationCode required A code that represents what the finding concerns, for example, the subject's height, blood pressure, disease status, wound dimensions, diabetes risk, etc. Although named ObservationCode, in different contexts the same attribute might be more naturally referred to as a property, observable, or test code. In assertions (observations without an explicit question), the observation code is defaulted to a value representing 'assertion'.
Interpretation optional A clinical interpretation of a finding.
ReferenceRange 0 or more The usual or acceptable range for a test result.
Components optional Components are parts of the parent observation. Component observations share the same attributes (such as Specimen) as the primary observation and are not separable. However, the reference range may be different for each component observation.

LifeEventOffset

A time in minutes before or after a given life event, for example, 30 minutes before a meal. Whether this means before or after is carried by the life event code.

Value:  unsignedInt

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

Based On Object

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.
Type optional The most specific code (lowest level term) describing the kind or sort of thing being represented.
RelatedEncounter optional If content was generated during a patient encounter, related encounter is the encounter where the information was gained.
Author optional The person or organization who created the entry and is responsible for (and may certify) the content.
Informant optional The person or entity that provided the information in the entry, as distinct from who created the entry, e.g. the subject (patient), medical professional, family member, device or software program.

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

The lower limit on a range

Value:  Quantity A quantity with units, whose value may be bounded from above or below, as defined in FHIR

LowerLimit

The lower limit of detection of the measured points. This is needed if any of the data points have the value 'L' (lower than detection limit).

Value:  decimal

MaxCount

Upper bound on a count.

Value:  integer

MillisecondsBetweenSamples

The length of time between sampling times, measured in milliseconds.

Value:  decimal

MinCount

Lower bound on a count.

Value:  integer

Money

Representation of an amount of currency or monetary value.

Based On Quantity

Value:  decimal
Units must be from CurrencyVS optional Code for the unit of measure of the quantity.
Comparator optional

NumberOfRepeats

How many times the action should be repeated.

Value:  positiveInt

Numerator

The dividend of a fraction. C2825219

Value:  Quantity A quantity with units, whose value may be bounded from above or below, as defined in FHIR

OccurrenceDuration

The length of time in which something happens.

Value:  Duration The length of time that something continues.

OccurrencePeriod

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

Based On OccurrenceTimeOrPeriod

Value:  TimePeriod A period of time defined by a start and end time, date, or year. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.

OccurrenceTime

The point in time in which something happens.

Based On OccurrenceTimeOrPeriod

Value:  dateTime

OccurrenceTimeOrPeriod

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

Value:  Choice
         |  date required
         |  dateTime required
         |  TimePeriod required A period of time defined by a start and end time, date, or year. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.

OnBehalfOf

The party represented by the actual participant.

Value:  Choice
         |  uri required
         |  Party required A person, organization, or object that can participate in a healthcare activity.

OrganizationalIdentifier

A code identifying a specific organization. The NPI should be provided, if available. Other business identifiers, such employer tax ID, or MVX code for vaccine manufacturers, should also be provided.

Based On Identifier

Value:  string
TimePeriod optional A period of time defined by a start and end time, date, or year. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.
Organization optional A social or legal structure formed by human beings.
Purpose must be from http://hl7.org/fhir/ValueSet/identifier-use optional Describes how the item is (or was) used or applied.
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.

Origin

The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.

Value:  SimpleQuantity A quantity where the comparator is not used, as defined in FHIR

ParsableContent

A string that follows a formal syntax and can be analyzed and broken into meaningful parts.

Based On EmbeddedContent

Value:  string
Formalism required The system of formal syntax or interpretation associated with parsable content.

Percentage

A percentage value where 100.0 represents 100%. C0439165

Value:  Quantity Units is % A quantity with units, whose value may be bounded from above or below, as defined in FHIR

PlainText

A text written in a human language.

Value:  string
Language optional A human language, spoken or written.

PostalCode

A sequence of letters and digits used as part of a postal address, often designating a geographic region C1514254

Value:  string

Priority

An indication of the importance of an action. C0549179

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

Qount

The whole number of items, as a unit-bearing quantity. C0750480

Based On Quantity

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

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, whose value may be bounded from above or below, as defined in FHIR

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

Range

An interval defined by a quantitative upper and/or lower bound. One of the two bounds must be specified, and the lower bound must be less than the upper bound. When Quantities are specified, the units of measure must be the same.

LowerBound must be a SimpleQuantity optional The lower limit on a range
UpperBound must be a SimpleQuantity optional The upper limit on a quantitative value.

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.
         |  Content required A item that can constitute the payload of an Entry, aka an EntryElement.

ReceivedTime

Time received by accepting facility or unit. C2735124

Value:  dateTime

RecurrenceInterval

The period of time after which the pattern repeats, for example, each day. To specify an event should take place every other Monday, the recurrence interval should be two weeks, and DayOfWeek should be Monday.

Value:  Duration The length of time that something continues.

RecurrencePattern

A set of rules that describe when a recurring event is scheduled.

RecurrenceInterval optional The period of time after which the pattern repeats, for example, each day. To specify an event should take place every other Monday, the recurrence interval should be two weeks, and DayOfWeek should be Monday.
DayOfWeek 0 or more A day of the week that the pattern should take place.
TimeOfDay 0 or more Time of day the event should take place on the designated day(s). TimeOfDay should only be specified if the RecurrenceInterval and/or DayOfWeek establishes the day when the event should take place.
DailyLifeEvent 0 or more A quotidian landmark, such as rising, mealtime, or bedtime, when an event should take place.
LifeEventOffset optional A time in minutes before or after a given life event, for example, 30 minutes before a meal. Whether this means before or after is carried by the life event code.
CountPerInterval optional How many times the event should take place during one recurrence interval, for example, to specify 3-4 times per day, the CountPerInterval should be 3 to 4.

RecurrenceRange

The start and end of the overall recurrence pattern in terms of dates/times or in terms of number of repeats. Could also be an event, such as when all doses are taken.

Value:  Choice
         |  TimePeriod required A period of time defined by a start and end time, date, or year. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.
         |  NumberOfRepeats required How many times the action should be repeated.

ResourceLocation

URI where data can be found.

Value:  uri

ResourceSize

Number of bytes of content in the resource (if url provided)

Value:  unsignedInt

SampledData

Data that comes from a series of measurements taken by a device, which may have upper and lower limits. The data type also supports more than one dimension in the data.

Value:  string
Origin required The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.
MillisecondsBetweenSamples required The length of time between sampling times, measured in milliseconds.
CorrectionFactor optional A correction factor that is applied to the sampled data points before they are added to the origin.
LowerLimit optional The lower limit of detection of the measured points. This is needed if any of the data points have the value 'L' (lower than detection limit).
UpperLimit optional The upper limit of detection of the measured points. This is needed if any of the data points have the value 'U' (higher than detection limit).
Dimensions required The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

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.

Signatory

The party signing.

Value:  Choice
         |  uri required
         |  Party required A person, organization, or object that can participate in a healthcare activity.

Signature

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

TypeAsaCoding from http://hl7.org/fhir/ValueSet/signature-type (if covered) 1 or more
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.

SimpleQuantity

A quantity where the comparator is not used, as defined in FHIR

Based On Quantity

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

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

Based On GeopoliticalLocation

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.
Comparator optional
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.

TelecomNumberOrAddress

A user name or other identifier on a telecommunication network, such as a telephone number (including country code and extension, if necessary), email address, or SkypeID.

Value:  string

TimeOfDay

Time of day the event should take place on the designated day(s). TimeOfDay should only be specified if the RecurrenceInterval and/or DayOfWeek establishes the day when the event should take place.

Value:  time

TimePeriod

A period of time defined by a start and end time, date, or year. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May. C1948053

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

TimePeriodEnd

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

Value:  dateTime

TimePeriodStart

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

Value:  dateTime

Timing

A timing schedule that specifies an event that may occur multiple times. Timing offers a choice of multiple OccurrenceTime (used is used to specify specific times), or recurrence patterns.

OccurrenceTime 0 or more The point in time in which something happens.
TimingCode optional A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
EventDuration optional The length of the recurring event.
RecurrencePattern optional A set of rules that describe when a recurring event is scheduled.
RecurrenceRange optional The start and end of the overall recurrence pattern in terms of dates/times or in terms of number of repeats. Could also be an event, such as when all doses are taken.

TimingCode

A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

Value:  CodeableConcept from http://hl7.org/fhir/ValueSet/timing-abbreviation (if covered) A set of codes drawn from different coding systems, representing the same concept.

Title

A distinguishing word or group of words naming an item.

Value:  string

TypeAsaCoding

No Description 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.

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.
Purpose must be from http://hl7.org/fhir/ValueSet/address-use optional Describes how the item is (or was) used or applied.
Type must be from http://hl7.org/fhir/ValueSet/address-type optional The most specific code (lowest level term) describing the kind or sort of thing being represented.
DisplayText optional A string meant for reading by a person, for example, accompanying a code.
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 municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR).
District optional The name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. Outside the US, a district or the equivalent. (Source: HL7 FHIR).
PostalCode optional A sequence of letters and digits used as part of a postal address, often designating a geographic region
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

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

The upper limit on a quantitative value.

Value:  Quantity A quantity with units, whose value may be bounded from above or below, as defined in FHIR

UpperLimit

The upper limit of detection of the measured points. This is needed if any of the data points have the value 'U' (higher than detection limit).

Value:  decimal

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

Based On ObservationComponent

Value:  Quantity Units is TBD A quantity with units, whose value may be bounded from above or below, as defined in FHIR
ValueAbsentReason optional Provides a reason why the value of the observation is missing, if it is expected (some observations are not expected to have a value).
ObservationCode required A code that represents what the finding concerns, for example, the subject's height, blood pressure, disease status, wound dimensions, diabetes risk, etc. Although named ObservationCode, in different contexts the same attribute might be more naturally referred to as a property, observable, or test code. In assertions (observations without an explicit question), the observation code is defaulted to a value representing 'assertion'.
Interpretation optional A clinical interpretation of a finding.
ReferenceRange 0 or more The usual or acceptable range for a test result.
Components optional Components are parts of the parent observation. Component observations share the same attributes (such as Specimen) as the primary observation and are not separable. However, the reference range may be different for each component observation.

Width

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

Based On ObservationComponent

Value:  Quantity Units is TBD A quantity with units, whose value may be bounded from above or below, as defined in FHIR
ValueAbsentReason optional Provides a reason why the value of the observation is missing, if it is expected (some observations are not expected to have a value).
ObservationCode required A code that represents what the finding concerns, for example, the subject's height, blood pressure, disease status, wound dimensions, diabetes risk, etc. Although named ObservationCode, in different contexts the same attribute might be more naturally referred to as a property, observable, or test code. In assertions (observations without an explicit question), the observation code is defaulted to a value representing 'assertion'.
Interpretation optional A clinical interpretation of a finding.
ReferenceRange 0 or more The usual or acceptable range for a test result.
Components optional Components are parts of the parent observation. Component observations share the same attributes (such as Specimen) as the primary observation and are not separable. However, the reference range may be different for each component observation.