Skip to main content

Base

The SHR Base domain contains definitions for basic classes in SHR, including the base Entry and Any. The classes below Any are are Finding, Action, and Entity.

Any [Abstract]

The top level class in the hierarchy

Attribution

Who the entry is attributed to, for example, the informer (information source), the recorder, the verifier, the responsible person, etc.

Role required 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.
ParticipationType required The role played by the participant engaged in the action, for example, as the attending physician, surgical assistant, etc.

Author

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

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

Content [Abstract]

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

Based On Any

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.

Entry

Metadata attributes that apply to any item represented in the standard health record. An Entry may not belong exclusively to a single person's health record, but could represent an entity that surfaces in multiple records, such as organizations or practitioners. If the entry belongs to a single person's record, then the identity of the person of record must be recorded. C1705654

Based On Any

ShrId required A unique, persistent, permanent identifier for the overall health record belonging to the PersonOfRecord.
EntryId required A persistent, permanent identifier for an entry in a health record, unique within the scope of the health record.
PersonOfRecord optional The person this record belongs to.
Version optional 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.
EntryType 1 or more SHR data element identifier, as a URI. The EntryType array includes the entire 'based on' hierarchy to enable searching for classes of things, for example, searching for all vital signs, or all types of behavioral observations.
CreationTime required The point in time when the information was recorded in the system of record.
LastUpdated required The most recent date the entry was changed.
Narrative optional A human-readable narrative, potentially including images, that contains a summary of the resource, and may be used to represent the content of the resource to a human.
Language optional A human language, spoken or written.
SecurityLabel 0 or more A code that connects the entry to a security policy. Security labels can be updated when the resource changes, or whenever the security sub-system chooses to.
Tag 0 or more A code used to relate entries to categories or workflows. Applications are not required to consider the tags when interpreting the meaning of an entry.

EntryId

A persistent, permanent identifier for an entry in a health record, unique within the scope of the health record. C0600091

Value:  id

EntryType

SHR data element identifier, as a URI. The EntryType array includes the entire 'based on' hierarchy to enable searching for classes of things, for example, searching for all vital signs, or all types of behavioral observations.

Value:  uri

Informant

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

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

Language

A human language, spoken or written. C0023008

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

LastUpdated

The most recent date the entry was changed.

Value:  instant

Narrative

A human-readable narrative, potentially including images, that contains a summary of the resource, and may be used to represent the content of the resource to a human.

Value:  xhtml
NarrativeQualifier required Additional information on how the narrative was generated, and the scope of information contained.

NarrativeQualifier

Additional information on how the narrative was generated, and the scope of information contained.

Value:  code must be from http://hl7.org/fhir/ValueSet/narrative-status

PersonOfRecord

The person this record belongs to.

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

RelatedEncounter

If content was generated during a patient encounter, related encounter is the encounter where the information was gained.

Value:  EncounterPerformed

SecurityLabel

A code that connects the entry to a security policy. Security labels can be updated when the resource changes, or whenever the security sub-system chooses to.

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.

ShrId

A unique, persistent, permanent identifier for the overall health record belonging to the PersonOfRecord.

Value:  id

Subject

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.

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

Tag

A code used to relate entries to categories or workflows. Applications are not required to consider the tags when interpreting the meaning of an entry.

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.