Skip to main content

Entity

The SHR Entity domain contains definitions for objects, people and organizations that are involved with the person of record, in some capacity. Entities are things that have separate and distinct existence and objective or conceptual reality. Includes information items, physical objects, health states, and parties.

AccessionIdentifier

Identifier assigned by the lab

Value:  Identifier A unique string that identifies a specific person or thing.

AccessTime

Point in time when data was accessed.

Value:  dateTime

ActiveFlag

If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.

Value:  boolean

ActiveFlagAsaCodeableConcept

If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.

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

Additive

Additive associated with container.

Value:  Choice required
         |  CodeableConcept 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.

AdministrativeGender

A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender. C1550327

Value:  code must be from http://hl7.org/fhir/ValueSet/administrative-gender

Affiliation

Membership, association, or connection to an organization. C0932026

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

AgeAtDeath

The age, age range, or age group when the cessation of life happens. C1546180

Value:  GeneralizedAge Qualitative or quantitative, exact or inexact description of age.

AnonymizedFlag

Flag indicating if personally identifiable information has been withheld or disguised. C3858751

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

BirthSex

Administrative sex assigned at birth and recorded on birth certificate. C4086849

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

BodySite

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

Based On Entity

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 Further detail of the anatomical location or specimen detailing whether it includes the entire entity or only a part or portion.
ClockDirection optional A direction indicated by an angle relative to 12 o'clock.
Distance optional The measure of space separating two objects or points.
Details optional An text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information.
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.
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.

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

BodySiteOrCode

A body site entity or a body site code.

Value:  Choice required
         |  CodeableConcept must be from BodySiteVS
A set of codes drawn from different coding systems, representing the same concept.
         |  BodySite A location or structure in the body, including tissues, regions, cavities, and spaces, for example, right elbow, or left ventricle of the heart.

Brand

If the product is branded, and if so, the brand name of a product.

Value:  boolean
BrandName optional The marketing name for a brand name product

BrandName

The marketing name for a brand name product

Value:  string

Capacity

Container volume or size.

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

CountryOfIssue

A country acting as an assuing authority for a document.

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

DateOfBirth

A date of birth or approximate year or period (year or date range), if estimated. C2919018 21112-8

Value:  Choice required
         |  date
         |  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.

DateOfDeath

The calendar date of subject's death. C1148348

Value:  dateTime

Deceased

An indication that the person is no longer living, given by a date, time of death, or a boolean value which, when true, indicates the person is deceased. C0011065

Value:  boolean
DateOfDeath optional The calendar date of subject's death.
AgeAtDeath optional The age, age range, or age group when the cessation of life happens.

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.

DoseForm

The form in which active and/or inert ingredient(s) are physically presented. C0013058

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

DriversLicenseNumber

Identifying information from a drivers license.

Value:  string
StateOfIssue optional A state or country acting as an assuing authority for a document.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

Entity [Abstract]

Base class for material and non-material things. A non-material thing might be a goal or information relevant to health care, such as an image, consent form, or report. A material thing can be seen and touched, such as a device.

Based On Party

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.

Ethnicity

Indicator of Hispanic or Latino origin. C0015031

Value:  CodeableConcept must be from http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity
A set of codes drawn from different coding systems, representing the same concept.
EthnicityDetail 0 or more Additional description of ethnicity.

EthnicityDetail

Additional description of ethnicity.

Value:  Choice required
         |  CodeableConcept must be from http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity
A set of codes drawn from different coding systems, representing the same concept.
         |  CodeableConcept must be from http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
A set of codes drawn from different coding systems, representing the same concept.

ExcludeFlag

If true, exclude the subjects that match the criterion. C0680251

Value:  boolean

ExpirationDate

When the medication will expire.

Value:  dateTime

ExternalHealthRecord

A health record other than the current health record; may have been used to help populate the current record.

Based On Entity

Identifier required A unique string that identifies a specific person or thing.
AccessTime required Point in time when data was accessed.
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.

Facility [Entry]

Services and space and equipment provided for a particular purpose; a building or place that provides a particular service or is used for a particular industry. Could be a clinical site, community site, or a mobile facility. C1547538

Based On Entity

FacilityName required The DBA (doing business as) or most commonly-used name for a facility.
Type must be from http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
Location required A position, site, or point in space where something can be found.
MobileFacility optional A facility that moves from place to place, such as Meals-On-Wheels.
ContactPoint optional An electronic means of contacting an organization or individual.
ManagingOrganization required The organization that manages the operation of an activity, facility, or service provision.
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.

FacilityName

The DBA (doing business as) or most commonly-used name for a facility. C3261404

Value:  string

FathersName

The name of the father as it was or likely to have been recorded on the birth certificate of the subject; most likely the name of the father at the time of birth of the subject.

Value:  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.).

FictionalPersonFlag

Flag indicating if this record represents a fictional (synthetic, not real) person. C0887933

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

Group [Entry]

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

Based On Entity

ActiveFlag optional If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.
Type must be from http://hl7.org/fhir/ValueSet/group-type
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
Title optional A distinguishing word or group of words naming an item.
Definitional required 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.
MembershipCriterion 0 or more An inclusion or exclusion criterion as part of defining a cohort. If the criterion is an unary, then ObservationCode must be SCT#385432009 (not applicable)
Member 0 or more A person or entity in a group.
Count optional The number of items (0 or more), as an integer.
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.

HandlingRisk

Cautions on the handling of this specimen.

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

Headshot

A photograph showing a person's face.

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

Ingredient

Specifies an material component in a non-medication substance. C3176062

Value:  Choice required
         |  CodeableConcept 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.
IngredientAmount required The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

IngredientAmount

The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

Value:  Ratio A unit of measurement for the quotient of the amount of one entity to another.

IsActiveIngredient

True if the ingredient is an active ingredient in the medication.

Value:  boolean

Issuer

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

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

LanguageQualifier

Additional information about a person's use of language.

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

LanguageUsed

Language used for communication by a human, either the subject of record, parent, or other involved person.

Value:  Language A human language, spoken or written.
SpokenLanguageProficiency optional Accuracy and fluency in spoken communication in a language.
WrittenLanguageProficiency optional Accuracy and fluency of reading and writing in a language.
LanguageQualifier 0 or more Additional information about a person's use of language.

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.

LotNumber

A distinctive alpha-numeric identification code assigned by the manufacturer or distributor to a specific quantity of manufactured material or product within a batch. C1115660

Value:  string

ManagingOrganization

The organization that manages the operation of an activity, facility, or service provision. C0677351

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

Manufacturer

The organization producing the product or test. C1114744

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

MaritalStatus

The most recent marital status of a person. C0024819

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

MedicalInterpreterNeeded

Whether the subject requires an interpreter to communicate with an English-speaking provider. C1442531

Value:  CodeableConcept must be from YesNoUnknownVS
A set of codes drawn from different coding systems, representing the same concept.
Language required A human language, spoken or written.

Medication [Entry]

A type of prescription drug or over-the-counter drug that is used to prevent, treat, or relieve symptoms of a disease or abnormal condition, but excluding vaccines. C0013227

Based On Entity

Type from http://hl7.org/fhir/us/core/ValueSet/us-core-medication-codes
(if covered)
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
DoseForm optional The form in which active and/or inert ingredient(s) are physically presented.
Brand optional If the product is branded, and if so, the brand name of a product.
OverTheCounter optional True if the medication is available to consumers without a prescription.
MedicationIngredient 0 or more Specifies an material component in a medication.
Manufacturer optional The organization producing the product or test.
LotNumber optional A distinctive alpha-numeric identification code assigned by the manufacturer or distributor to a specific quantity of manufactured material or product within a batch.
ExpirationDate optional When the medication will expire.
Package could be from http://hl7.org/fhir/ValueSet/medication-package-form
optional The kind of container the medication comes in.
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.

MedicationIngredient

Specifies an material component in a medication. C3176062

Value:  Choice required
         |  CodeableConcept 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.
         |  Medication A type of prescription drug or over-the-counter drug that is used to prevent, treat, or relieve symptoms of a disease or abnormal condition, but excluding vaccines.
IngredientAmount required The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
IsActiveIngredient required True if the ingredient is an active ingredient in the medication.

MedicationOrCode

A medication entity or a medication code.

Value:  Choice required
         |  CodeableConcept from http://hl7.org/fhir/us/core/ValueSet/us-core-medication-codes
(if covered)
A set of codes drawn from different coding systems, representing the same concept.
         |  Medication A type of prescription drug or over-the-counter drug that is used to prevent, treat, or relieve symptoms of a disease or abnormal condition, but excluding vaccines.

Member

A person or entity in a group. Member of Target Group (C0682343)

Value:  Choice required
         |  Patient A person in the role of a patient, including extended demographic information about the subject of this health record.
         |  Practitioner A person who practices a healing art.
         |  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.
         |  Medication A type of prescription drug or over-the-counter drug that is used to prevent, treat, or relieve symptoms of a disease or abnormal condition, but excluding vaccines.
         |  Substance Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.
ParticipationPeriod optional The point in time or span of time the participant is involved.
ActiveFlag required If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.

MembershipCriterion

An inclusion or exclusion criterion as part of defining a cohort. If the criterion is an unary, then ObservationCode must be SCT#385432009 (not applicable) C0599755

Value:  Choice required
         |  CodeableConcept A set of codes drawn from different coding systems, representing the same concept.
         |  boolean
         |  Quantity A quantity with units, whose value may be bounded from above or below, as defined in FHIR
         |  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.
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'.
ExcludeFlag required If true, exclude the subjects that match the criterion.
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.

MobileFacility

A facility that moves from place to place, such as Meals-On-Wheels. C0231435

Value:  boolean

MothersMaidenName

The name of the mother as it was or likely to have been recorded on the birth certificate of the subject. This is most likely the name prior to marriage of the mother (aka the maiden name). C0806887

Value:  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.).

MultipleBirth

Indication if the person was part of a multiple birth event. C0026753

Value:  boolean
MultipleBirthOrder optional Order of birth of the person in multiple birth event (if part of multiple birth).

MultipleBirthOrder

Order of birth of the person in multiple birth event (if part of multiple birth). 73771-8

Value:  integer

NationalProviderIdentifier

A unique 10-digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry. C1549728

Based On Identifier

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.

Organization [Entry]

A social or legal structure formed by human beings. C1561598

Based On Entity

OrganizationName required The name of the organization.
OrganizationAlias 0 or more A list of alternate names that the organization is known as, or was known as in the past.
OrganizationIdentifier 1 or more An identifier of the organization. An NPI preferred, tax id is allowed, and a local id is allowed in addition to ‘authoritative’ identifier
Type must be from http://hl7.org/fhir/ValueSet/organization-type
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
OrganizationIdentifier 1 or more An identifier of the organization. An NPI preferred, tax id is allowed, and a local id is allowed in addition to ‘authoritative’ identifier
Address 1 or more 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).
ContactPoint 1 or more An electronic means of contacting an organization or individual.
ActiveFlag required If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.
PartOf must be a Organization
optional The larger entity that this is a portion of.
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.

OrganizationAlias

A list of alternate names that the organization is known as, or was known as in the past.

Value:  string

OrganizationIdentifier

An identifier of the organization. An NPI preferred, tax id is allowed, and a local id is allowed in addition to ‘authoritative’ identifier

Based On Identifier

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.

OrganizationName

The name of the organization.

Value:  string

OverTheCounter

True if the medication is available to consumers without a prescription.

Value:  boolean

Package

The kind of container the medication comes in.

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

PartOf

The larger entity that this is a portion of.

Value:  Content An item that can constitute the payload of an Entry, aka an EntryElement.

Party [Abstract]

A person, organization, or object that be involved in a healthcare activity. A party has a separate and distinct existence, and objective or conceptual reality. Includes information, physical objects, and roles.

Based On Content

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.

PassportNumber

Credential indicating citizenship. C1549737

Value:  string
CountryOfIssue required A country acting as an assuing authority for a document.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.

Patient [Entry]

A person in the role of a patient, including extended demographic information about the subject of this health record. C1299487

Based On Role

Value:  _Value must be a Person
PlaceOfBirth required The location of a birth event. There may be multiple entries, but a person has only one place of birth.
MultipleBirth optional Indication if the person was part of a multiple birth event.
BirthSex required Administrative sex assigned at birth and recorded on birth certificate.
Race required Subjective association of a person with a named category of humans sharing common history, traits, place of family origin, nationality, tribe, or other inherited background.
Ethnicity required Indicator of Hispanic or Latino origin.
MaritalStatus required The most recent marital status of a person.
MothersMaidenName required The name of the mother as it was or likely to have been recorded on the birth certificate of the subject. This is most likely the name prior to marriage of the mother (aka the maiden name).
FathersName required The name of the father as it was or likely to have been recorded on the birth certificate of the subject; most likely the name of the father at the time of birth of the subject.
SocialSecurityNumber optional A US social security number (SSN).
DriversLicenseNumber optional Identifying information from a drivers license.
PassportNumber 0 or more Credential indicating citizenship.
MedicalInterpreterNeeded optional Whether the subject requires an interpreter to communicate with an English-speaking provider.
Deceased optional An indication that the person is no longer living, given by a date, time of death, or a boolean value which, when true, indicates the person is deceased.
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.

Person [Entry]

A person relevant to the health or social situation of the subject (including the person of record him or herself). C0027361

Based On Entity

HumanName 0 or more 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.).
AnonymizedFlag optional Flag indicating if personally identifiable information has been withheld or disguised.
FictionalPersonFlag optional Flag indicating if this record represents a fictional (synthetic, not real) person.
DateOfBirth optional A date of birth or approximate year or period (year or date range), if estimated.
AdministrativeGender optional A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender.
Address 0 or more 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).
Headshot optional A photograph showing a person's face.
ContactPoint 0 or more An electronic means of contacting an organization or individual.
LanguageUsed 0 or more Language used for communication by a human, either the subject of record, parent, or other involved person.
ActiveFlag optional If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.
ExternalHealthRecord 0 or more A health record other than the current health record; may have been used to help populate the current record.
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.

PlaceOfBirth

The location of a birth event. There may be multiple entries, but a person has only one place of birth. C0032040

Value:  GeopoliticalLocation The countries of the world and major geopolitical subregions, such as US states.

PortionTotality

Further detail of the anatomical location or specimen detailing whether it includes the entire entity or only a part or portion. C99075

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

Practitioner

A person who practices a healing art. C2220264

Based On Role

Value:  _Value must be a Person
NationalProviderIdentifier required A unique 10-digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.
Qualification 0 or more A right to practice medicine obtained by training and certification.
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.

Purpose

Describes how the item is (or was) used or applied.

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

Qualification

A right to practice medicine obtained by training and certification. C0037778

Type must be from http://hl7.org/fhir/ValueSet/c80-practice-codes
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
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.

Race

Subjective association of a person with a named category of humans sharing common history, traits, place of family origin, nationality, tribe, or other inherited background. C0034510

Value:  CodeableConcept must be from http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity
A set of codes drawn from different coding systems, representing the same concept.
RaceDetail 0 or more Additional description of race or heritage.

RaceDetail

Additional description of race or heritage.

Value:  Choice required
         |  CodeableConcept must be from http://hl7.org/fhir/us/core/ValueSet/detailed-race
A set of codes drawn from different coding systems, representing the same concept.
         |  CodeableConcept must be from http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity
A set of codes drawn from different coding systems, representing the same concept.

RelatedPerson [Entry]

A person in a role defined in relationship to a patient

Based On Role

Value:  _Value must be a Person
RelationshipType optional The relationship of the subject to another person in the same extended family or extended family. May or may not be a blood relative.
EffectiveTimePeriod optional The date and time span for which something is active, valid, or in force.
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.

RelationshipType [Entry]

The relationship of the subject to another person in the same extended family or extended family. May or may not be a blood relative. C0015608

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

Role [Abstract]

Abstract parent class for human parties, such as practitioners, patients, research subjects, and related persons. Role can also represent an object playing a specific role, such as a room playing the role of operating theater. The value contains the entity (party) playing the role.

Based On Party

Value:  Party A person, organization, or object that be involved in a healthcare activity. A party has a separate and distinct existence, and objective or conceptual reality. Includes information, physical objects, and roles.
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.

SequenceNumber

The sequence number for this specimen in a collection of specimens.

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

SocialSecurityNumber

A US social security number (SSN). C1301821

Value:  string

SourceSpecimen

Identifier for the source specimen from which this specimen was derived.

Value:  Specimen Sample for analysis

SpecialHandling

Information about the proper handling of the specimen.

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

Specimen [Entry]

Sample for analysis

Based On Entity

AccessionIdentifier optional Identifier assigned by the lab
Status must be from http://hl7.org/fhir/ValueSet/specimen-status
optional Position in workflow.
Type must be from http://hl7.org/fhir/ValueSet/v2-0487
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
Subject required The person or thing that this entry relates to, usually the Person of Record. However, not all entries have health information specifically about the patient, but in different contexts, could refer to a fetus, family member (living or dead), device, location, organization, finding, condition, or intervention.
SourceSpecimen optional Identifier for the source specimen from which this specimen was derived.
ReceivedTime optional Time received by accepting facility or unit.
SpecimenCollectionPerformed optional
SpecimenContainer 0 or more Direct container of specimen (tube/slide, etc.)
SpecimenTreatment 0 or more Treatment performed on the specimen.
HandlingRisk 0 or more Cautions on the handling of this specimen.
SpecialHandling 0 or more Information about the proper handling of the specimen.
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.

SpecimenContainer [Entry]

Direct container of specimen (tube/slide, etc.)

Based On Entity

Type optional The most specific code (lowest level term) describing the kind or sort of thing being represented.
Identifier optional A unique string that identifies a specific person or thing.
Details optional An text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information.
Capacity optional Container volume or size.
SpecimenQuantity optional Quantity of specimen within container.
Additive 0 or more Additive associated with container.
SequenceNumber optional The sequence number for this specimen in a collection of specimens.
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.

SpecimenQuantity

Quantity of specimen within container.

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

SpecimenTreatment [Entry]

Treatment performed on the specimen.

Based On ProcedurePerformed

Additive 0 or more Additive associated with container.
ActionContext must be a PerformedContext
required The ontological status of the intervention, e.g., performed/not performed, requested/not requested.
Type from http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
(if covered)
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
Subject must be a Patient
required The person or thing that this entry relates to, usually the Person of Record. However, not all entries have health information specifically about the patient, but in different contexts, could refer to a fetus, family member (living or dead), device, location, organization, finding, condition, or intervention.
BodySite 0 or more A location or structure in the body, including tissues, regions, cavities, and spaces, for example, right elbow, or left ventricle of the heart.
AssociatedStudy optional The clinical trial or other formal study related to this procedure.
PartOf must be a ProcedurePerformed
optional The larger entity that this is a portion of.
Category optional A class or division of people or things having particular shared characteristics
Annotation 0 or more An added or follow-up note, often after the fact, that contains metadata about who made the statement and when.
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.

SpecimenType

Kind of material that forms the specimen

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

SpokenLanguageProficiency

Accuracy and fluency in spoken communication in a language. C0678997

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

StateOfIssue

A state or country acting as an assuing authority for a document.

Value:  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).

Substance [Entry]

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

Based On Entity

Type should be from http://hl7.org/fhir/ValueSet/substance-code
required The most specific code (lowest level term) describing the kind or sort of thing being represented.
Category from http://hl7.org/fhir/ValueSet/substance-category
(if covered)
0 or more A class or division of people or things having particular shared characteristics
ActiveFlagAsaCodeableConcept must be from http://hl7.org/fhir/ValueSet/substance-status
optional If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.
Details optional An text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information.
Ingredient 0 or more Specifies an material component in a non-medication substance.
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.

SubstanceOrCode

A substance entity or a substance code.

Value:  Choice required
         |  CodeableConcept should be from http://hl7.org/fhir/ValueSet/substance-code
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.

Type

The most specific code (lowest level term) describing the kind or sort of thing being represented. C0332307

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

WrittenLanguageProficiency

Accuracy and fluency of reading and writing in a language. C0586739

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