STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2

?.? HL7 v3 Namespaces (Code Systems and Value Sets)

These namespaces are defined for use in FHIR. Code Systems are used when representing codes that were defined as part of the HL7 v3 code systems. So if you are representing the code "M" from the code system AdministrativeGender in a FHIR instance, then you would use the system "http://hl7.org/fhir/v3/AdministrativeGender" (note that the namespace is case sensitive).

Value Set namespaces are used as part of the specification itself, or in Profiles or other Value Sets where HL7 v3 code systems are used.

All of these namespaces are subject to further change.

CodeSystems

See below for value sets.

Name (URI = http://hl7.org/fhir/v3/...)DescriptionOID
AcknowledgementCondition The codes identify the conditions under which accept acknowledgements are required to be returned in response to this message. Note that accept acknowledgement address two different issues at the same time: reliable transport as well as syntactical correctness2.16.840.1.113883.5.1050
AcknowledgementDetailCode OpenIssue: Missing description.2.16.840.1.113883.5.1100
AcknowledgementDetailType A code identifying the specific message to be provided. Discussion: A textual value may be specified as the print name, or for non-coded messages, as the original text. Examples: 'Required attribute xxx is missing', 'System will be unavailable March 19 from 0100 to 0300'2.16.840.1.113883.5.1082
AcknowledgementType This attribute contains an acknowledgement code as described in the HL7 message processing rules. OpenIssue: Description was copied from attribute and needs to be improved to be appropriate for a code system.2.16.840.1.113883.5.18
ActClass**** MISSING DEFINITIONS ****2.16.840.1.113883.5.6
ActCode A code specifying the particular kind of Act that the Act-instance represents within its class. Constraints: The kind of Act (e.g. physical examination, serum potassium, inpatient encounter, charge financial transaction, etc.) is specified with a code from one of several, typically external, coding systems. The coding system will depend on the class of Act, such as LOINC for observations, etc. Conceptually, the Act.code must be a specialization of the Act.classCode. This is why the structure of ActClass domain should be reflected in the superstructure of the ActCode domain and then individual codes or externally referenced vocabularies subordinated under these domains that reflect the ActClass structure. Act.classCode and Act.code are not modifiers of each other but the Act.code concept should really imply the Act.classCode concept. For a negative example, it is not appropriate to use an Act.code "potassium" together with and Act.classCode for "laboratory observation" to somehow mean "potassium laboratory observation" and then use the same Act.code for "potassium" together with Act.classCode for "medication" to mean "substitution of potassium". This mutually modifying use of Act.code and Act.classCode is not permitted.2.16.840.1.113883.5.4
ActExposureLevelCode A qualitative measure of the degree of exposure to the causative agent. This includes concepts such as "low", "medium" and "high". This quantifies how the quantity that was available to be administered to the target differs from typical or background levels of the substance.2.16.840.1.113883.5.1114
ActInvoiceElementModifier Processing consideration and clarification codes.2.16.840.1.113883.5.1051
ActMood OpenIssue: In Ballot 2009May, a strong Negative vote was lodged against several of the concept definitions in the vocabulary used for Act.moodCode. The vote was found "Persuasive With Mod", with the understanding that M and M would undertake a detailed review of these concept definitions for a future release of the RIM.2.16.840.1.113883.5.1001
ActPriority A set of codes (e.g., for routine, emergency), specifying the urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen.2.16.840.1.113883.5.7
ActReason A set of codes specifying the motivation, cause, or rationale of an Act, when such rationale is not reasonably represented as an ActRelationship of type "has reason" linking to another Act. Examples: Example reasons that might qualify for being coded in this field might be: "routine requirement", "infectious disease reporting requirement", "on patient request", "required by law".2.16.840.1.113883.5.8
ActRelationshipCheckpoint**** MISSING DEFINITIONS ****2.16.840.1.113883.5.10
ActRelationshipJoin**** MISSING DEFINITIONS ****2.16.840.1.113883.5.12
ActRelationshipSplit**** MISSING DEFINITIONS ****2.16.840.1.113883.5.13
ActRelationshipSubset <ns1:p>Used to indicate that the target of the relationship will be a filtered subset of the total related set of targets.</ns1:p><ns1:p>Used when there is a need to limit the number of components to the first, the last, the next, the total, the average or some other filtered or calculated subset.</ns1:p>2.16.840.1.113883.5.1099
ActRelationshipType The source is an excerpt from the target.2.16.840.1.113883.5.1002
ActSite An anatomical location on an organism which can be the focus of an act.2.16.840.1.113883.5.1052
ActStatus Codes representing the defined possible states of an Act, as defined by the Act class state machine.2.16.840.1.113883.5.14
ActUSPrivacyLaw A jurisdictional mandate in the US relating to privacy. Deprecation Comment: Content moved to ActCode under _ActPrivacyLaw; use that instead.2.16.840.1.113883.5.1138
ActUncertainty OpenIssue: Missing Description2.16.840.1.113883.5.1053
AddressPartType Description: Code that specifies whether an address part names the street, city, country, postal code, post box, etc. Discussion: The hierarchical nature of these concepts shows composition. E.g. "Street Name" is part of "Street Address Line"2.16.840.1.113883.5.16
AddressUse Codes that provide guidance around the circumstances in which a given address should be used.2.16.840.1.113883.5.1119
AdministrativeGender The gender of a person used for adminstrative purposes (as opposed to clinical gender)2.16.840.1.113883.5.1
AmericanIndianAlaskaNativeLanguages American Indian and Alaska Native languages currently being used in the United States.2.16.840.1.113883.5.1054
Calendar**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1055
CalendarCycle Calendar cycle identifiers2.16.840.1.113883.5.9
CalendarType**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1017
Charset Internet Assigned Numbers Authority (IANA) Charset Types2.16.840.1.113883.5.21
CodingRationale Identifies how to interpret the instance of the code, codeSystem value in a set of translations. Since HL7 (or a government body) may mandate that codes from certain code systems be sent in conformant messages, other synonyms that are sent in the translation set need to be distinguished among the originally captured source, the HL7 specified code, or some future role. When this code is NULL, it indicates that the translation is an undefined type. When valued, this property must contain one of the following values: SRC - Source (or original) code HL7 - HL7 Specified or Mandated SH - both HL7 mandated and the original code (precoordination) There may be additional values added to this value set as we work through the use of codes in messages and determine other Use Cases requiring special interpretation of the translations.2.16.840.1.113883.5.1074
CommunicationFunctionType Describes the type of communication function that the associated entity plays in the associated transmission.2.16.840.1.113883.5.1056
CompressionAlgorithm**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1009
Confidentiality A set of codes specifying the security classification of acts and roles in accordance with the definition for concept domain "Confidentiality".2.16.840.1.113883.5.25
ContainerCap The type of cap associated with a container2.16.840.1.113883.5.26
ContainerSeparator A material in a blood collection container that facilites the separation of of blood cells from serum or plasma2.16.840.1.113883.5.27
ContentProcessingMode Description: Identifies the order in which content should be processed.2.16.840.1.113883.5.1110
ContextControl A code that specifies how an ActRelationship or Participation contributes to the context of an Act, and whether it may be propagated to descendent Acts whose association allows such propagation (see also attributes Participation.contextControlCode, ActRelationship.contextControlCode, ActRelationship.contextConductionInd).2.16.840.1.113883.5.1057
DataOperation**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1123
DeviceAlertLevel Domain values for the Device.Alert_levelCode2.16.840.1.113883.5.31
DocumentCompletion Identifies the current completion state of a clinical document.2.16.840.1.113883.5.33
DocumentStorage Identifies the storage status of a document.2.16.840.1.113883.5.34
EducationLevel Years of education that a person has completed2.16.840.1.113883.5.1077
EmployeeJobClass**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1059
EncounterAdmissionSource**** MISSING DEFINITIONS ****2.16.840.1.113883.5.37
EncounterSpecialCourtesy**** MISSING DEFINITIONS ****2.16.840.1.113883.5.40
EntityClass Classifies the Entity class and all of its subclasses. The terminology is hierarchical. At the top is this HL7-defined domain of high-level categories (such as represented by the Entity subclasses). Each of these terms must be harmonized and is specializable. The value sets beneath are drawn from multiple, frequently external, domains that reflect much more fine-grained typing.2.16.840.1.113883.5.41
EntityCode OpenIssue: Missing description.2.16.840.1.113883.5.1060
EntityDeterminer EntityDeterminer in natural language grammar is the class of words that comprises articles, demonstrative pronouns, and quantifiers. In the RIM, determiner is a structural code in the Entity class to distinguish whether any given Entity object stands for some, any one, or a specific thing.2.16.840.1.113883.5.30
EntityHandling**** MISSING DEFINITIONS ****2.16.840.1.113883.5.42
EntityNamePartQualifier OpenIssue: Needs description2.16.840.1.113883.5.43
EntityNamePartQualifierR2 Description: The qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.2.16.840.1.113883.5.1122
EntityNamePartType**** MISSING DEFINITIONS ****2.16.840.1.113883.5.44
EntityNamePartTypeR2 Description: Indicates whether the name part is a given name, family name, prefix, suffix, etc.2.16.840.1.113883.5.1121
EntityNameUse**** MISSING DEFINITIONS ****2.16.840.1.113883.5.45
EntityNameUseR2 Description: A set of codes advising a system or user which name in a set of names to select for a given purpose.2.16.840.1.113883.5.1120
EntityRisk Kinds of risks associated with the handling of the material..2.16.840.1.113883.5.46
EntityStatus Codes representing the defined possible states of an Entity, as defined by the Entity class state machine.2.16.840.1.113883.5.1061
EquipmentAlertLevel**** MISSING DEFINITIONS ****2.16.840.1.113883.5.49
Ethnicity In the United States, federal standards for classifying data on ethnicity determine the categories used by federal agencies and exert a strong influence on categorization by state and local agencies and private sector organizations. The federal standards do not conceptually define ethnicity, and they recognize the absence of an anthropological or scientific basis for ethnicity classification. Instead, the federal standards acknowledge that ethnicity is a social-political construct in which an individual's own identification with a particular ethnicity is preferred to observer identification. The standards specify two minimum ethnicity categories: Hispanic or Latino, and Not Hispanic or Latino. The standards define a Hispanic or Latino as a person of "Mexican, Puerto Rican, Cuban, South or Central America, or other Spanish culture or origin, regardless of race." The standards stipulate that ethnicity data need not be limited to the two minimum categories, but any expansion must be collapsible to those categories. In addition, the standards stipulate that an individual can be Hispanic or Latino or can be Not Hispanic or Latino, but cannot be both.2.16.840.1.113883.5.50
ExposureMode Code for the mechanism by which the exposure agent was exchanged or potentially exchanged by the participants involved in the exposure.2.16.840.1.113883.5.1113
GTSAbbreviation**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1022
GenderStatus**** MISSING DEFINITIONS ****2.16.840.1.113883.5.51
HL7UpdateMode The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.2.16.840.1.113883.5.57
HtmlLinkType HtmlLinkType values are drawn from HTML 4.0 and describe the relationship between the current document and the anchor that is the target of the link2.16.840.1.113883.5.58
IdentifierReliability Specifies the reliability with which the identifier is known. This attribute MAY be used to assist with identifier matching algorithms.2.16.840.1.113883.5.1117
IdentifierScope Description: Codes to specify the scope in which the identifier applies to the object with which it is associated, and used in the datatype property II.2.16.840.1.113883.5.1116
IntegrityCheckAlgorithm**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1010
LanguageAbilityMode A value representing the method of expression of the language. Example: Expressed spoken, expressed written, expressed signed, received spoken, received written, received signed. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.5.60
LanguageAbilityProficiency A value representing the level of proficiency in a language. Example: Excellent, good, fair, poor. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.5.61
LivingArrangement A code depicting the living arrangements of a person2.16.840.1.113883.5.63
LocalMarkupIgnore Tells a receiver to ignore just the local markup tags (local_markup, local_header, local_attr) when value="markup", or to ignore the local markup tags and all contained content when value="all"2.16.840.1.113883.5.65
LocalRemoteControlState**** MISSING DEFINITIONS ****2.16.840.1.113883.5.66
ManagedParticipationStatus Codes representing the defined possible states of a Managed Participation, as defined by the Managed Participation class state machine.2.16.840.1.113883.5.1062
MapRelationship The closeness or quality of the mapping between the HL7 concept (as represented by the HL7 concept identifier) and the source coding system. The values are patterned after the similar relationships used in the UMLS Metathesaurus. Because the HL7 coding sy2.16.840.1.113883.5.67
MaritalStatus * * * No description supplied * * * Open Issue: The specific meanings of these codes can vary somewhat by jurisdiction and implementation so caution should be used when determining equivalency.2.16.840.1.113883.5.2
MessageWaitingPriority Indicates that the receiver has messages for the sender OpenIssue: Description does not make sense relative to name of coding system. Must be reviewed and improved.2.16.840.1.113883.5.1083
ModifyIndicator**** MISSING DEFINITIONS ****2.16.840.1.113883.5.81
NullFlavor A collection of codes specifying why a valid value is not present.2.16.840.1.113883.5.1008
ObservationInterpretation One or more codes specifying a rough qualitative interpretation of the observation, such as "normal", "abnormal", "below normal", "change up", "resistant", "susceptible", etc. OpenIssue: Description copied from Concept Domain of same name. Must be verified. Note also that this might be identical to the V2 code system of interpretation codes (formerly Abnormal Flags in older versions).2.16.840.1.113883.5.83
ObservationMethod A code that provides additional detail about the means or technique used to ascertain the observation. Examples: Blood pressure measurement method: arterial puncture vs. sphygmomanometer (Riva-Rocci), sitting vs. supine position, etc. OpenIssue: Description copied from Concept Domain of same name. Must be verified. Note that the Domain has a full discussion about use of the attribute and constraining that is not appropriate for the code system description. Needs to be improved.2.16.840.1.113883.5.84
ObservationValue This domain is the root domain to which all HL7-recognized value sets for the Observation.value attribute will be linked when Observation.value has a coded data type. OpenIssue: Description copied from Concept Domain of same name. Must be corrected..2.16.840.1.113883.5.1063
ParticipationFunction This code is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (CWE).2.16.840.1.113883.5.88
ParticipationMode A set of codes specifying the modality by which the Entity playing the Role is participating in the Act. Examples: Physically present, over the telephone, written communication. Rationale: Particularly for author (originator) participants this is used to specify whether the information represented by the act was initially provided verbally, (hand-)written, or electronically. Open Issue: There needs to be a reexamination of the hierarchies as there seems to be some muddling between ELECTRONIC and other concepts that involve electronic communication that are in other hierarchies.2.16.840.1.113883.5.1064
ParticipationSignature A set of codes specifying whether and how the participant has attested his participation through a signature and or whether such a signature is needed. Examples: A surgical Procedure act object (representing a procedure report) requires a signature of the performing and responsible surgeon, and possibly other participants. (See also: Participation.signatureText.)2.16.840.1.113883.5.89
ParticipationType**** MISSING DEFINITIONS ****2.16.840.1.113883.5.90
PatientImportance Patient VIP code2.16.840.1.113883.5.1075
PaymentTerms Describes payment terms for a financial transaction, used in an invoice. This is typically expressed as a responsibility of the acceptor or payor of an invoice.2.16.840.1.113883.5.91
PersonDisabilityType A code identifying a person's disability.2.16.840.1.113883.5.93
ProbabilityDistributionType**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1020
ProcessingID Codes used to specify whether a message is part of a production, training, or debugging system.2.16.840.1.113883.5.100
ProcessingMode**** MISSING DEFINITIONS ****2.16.840.1.113883.5.101
QueryParameterValue The domain of coded values used as parameters within QueryByParameter queries.2.16.840.1.113883.5.1096
QueryPriority**** MISSING DEFINITIONS ****2.16.840.1.113883.5.102
QueryRequestLimit Definition: Defines the units associated with the magnitude of the maximum size limit of a query response that can be accepted by the requesting application.2.16.840.1.113883.5.1112
QueryResponse A code classifying the general nature of the response to a given query. Includes whether or not data was found, or whether an error occurred.2.16.840.1.113883.5.1067
QueryStatusCode A code specifying the state of the Query.2.16.840.1.113883.5.103
Race In the United States, federal standards for classifying data on race determine the categories used by federal agencies and exert a strong influence on categorization by state and local agencies and private sector organizations. The federal standards do not conceptually define race, and they recognize the absence of an anthropological or scientific basis for racial classification. Instead, the federal standards acknowledge that race is a social-political construct in which an individual's own identification with one more race categories is preferred to observer identification. The standards use a variety of features to define five minimum race categories. Among these features are descent from "the original peoples" of a specified region or nation. The minimum race categories are American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, and White. The federal standards stipulate that race data need not be limited to the five minimum categories, but any expansion must be collapsible to those categories.2.16.840.1.113883.5.104
RelationalOperator**** MISSING DEFINITIONS ****2.16.840.1.113883.5.105
RelationshipConjunction**** MISSING DEFINITIONS ****2.16.840.1.113883.5.106
ReligiousAffiliation Assigment of spiritual faith affiliation2.16.840.1.113883.5.1076
ResponseLevel Specifies whether a response is expected from the addressee of this interaction and what level of detail that response should include2.16.840.1.113883.5.108
ResponseModality Defines the timing and grouping of the response instances. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.5.109
ResponseMode Specifies the mode, immediate versus deferred or queued, by which a receiver should communicate its receiver responsibilities.2.16.840.1.113883.5.1126
RoleClass Codes for the Role class hierarchy. The values in this hierarchy, represent a Role which is an association or relationship between two entities - the entity that plays the role and the entity that scopes the role. Roles names are derived from the name of the playing entity in that role. The role hierarchy stems from three core concepts, or abstract domains: RoleClassOntological is an abstract domain that collects roles in which the playing entity is defined or specified by the scoping entity. RoleClassPartitive collects roles in which the playing entity is in some sense a "part" of the scoping entity. RoleClassAssociative collects all of the remaining forms of association between the playing entity and the scoping entity. This set of roles is further partitioned between: RoleClassPassive which are roles in which the playing entity is used, known, treated, handled, built, or destroyed, etc. under the auspices of the scoping entity. The playing entity is passive in these roles in that the role exists without an agreement from the playing entity. RoleClassMutualRelationship which are relationships based on mutual behavior of the two entities. The basis of these relationship may be formal agreements or they may bede facto behavior. Thus, this sub-domain is further divided into: RoleClassRelationshipFormal in which the relationship is formally defined, frequently by a contract or agreement. Personal relationship which inks two people in a personal relationship. The hierarchy discussed above is represented In the current vocabulary tables as a set of abstract domains, with the exception of the "Personal relationship" which is a leaf concept. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.5.110
RoleCode A set of codes further specifying the kind of Role; specific classification codes for further qualifying RoleClass codes.2.16.840.1.113883.5.111
RoleLinkStatus Description: Codes representing possible states of a RoleLink, as defined by the RoleLink class state machine.2.16.840.1.113883.5.1137
RoleLinkType**** MISSING DEFINITIONS ****2.16.840.1.113883.5.107
RoleStatus Codes representing the defined possible states of an Role, as defined by the Role class state machine.2.16.840.1.113883.5.1068
RouteOfAdministration The path the administered medication takes to get into the body or into contact with the body.2.16.840.1.113883.5.112
Sequencing Specifies sequence of sort order.2.16.840.1.113883.5.113
SetOperator**** MISSING DEFINITIONS ****2.16.840.1.113883.5.1069
SpecimenType**** MISSING DEFINITIONS ****2.16.840.1.113883.5.129
SubstitutionCondition Identifies what sort of change is permitted or has occurred between the item that was ordered/requested and the one that was/will be provided.2.16.840.1.113883.5.1071
TableCellHorizontalAlign These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.5.131
TableCellScope These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.5.132
TableCellVerticalAlign These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.5.133
TableFrame These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.5.134
TableRules These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.5.136
TargetAwareness**** MISSING DEFINITIONS ****2.16.840.1.113883.5.137
TelecommunicationCapabilities Description: Concepts that define the telecommunication capabilities of a particular device. Used to identify the expected capabilities to be found at a particular telecommunication address.2.16.840.1.113883.5.1118
TimingEvent**** MISSING DEFINITIONS ****2.16.840.1.113883.5.139
TransmissionRelationshipTypeCode Description: A code specifying the meaning and purpose of every TransmissionRelationship instance. Each of its values implies specific constraints to what kinds of Transmission objects can be related and in which way.2.16.840.1.113883.5.1111
TribalEntityUS INDIAN ENTITIES RECOGNIZED AND ELIGIBLE TO RECEIVE SERVICES FROM THE UNITED STATES BUREAU OF INDIAN AFFAIRS2.16.840.1.113883.5.140
VaccineManufacturer The manufacturer of a vaccine.2.16.840.1.113883.5.144
hl7Realm Description: Coded concepts representing Binding Realms (used for Context Binding of terminology in HL7 models) and/or Namespace Realms (used to help ensure unique identification of HL7 artifacts). This code system is partitioned into three sections: Affiliate realms, Binding realms and Namespace realms. All affiliate realm codes may automatically be used as both binding realms and namespace realms. Furthermore, affiliate realms are the only realms that have authority over the creation of binding realms. (Note that 'affiliate' includes the idea of both international affiliates and the HL7 International organization.) All other codes must be associated with an owning affiliate realm and must appear as a specialization of _BindingRealm or _NamespaceRealm. For affiliates whose concepts align with nations, the country codes from ISO 3166-1 2-character alpha are used for the code when possible so these codes should not be used for other realm types. It is recommended that binding realm and namespace codes submitted by affiliates use the realm code as a prefix to avoid possible collisions with ISO codes. However, tooling does not currently support namepace realm codes greater than 2 characters. Open Issue: The name of the concept property "owningAffiliate" should be changed to better reflect that the property value is the human readable name of the organizational entity that manages the Realm identified by the Realm Code. Open Issue: In spite of the inability of tooling to process codes longer than 2 characters, there is at least one realm codes ('SOA') that was added that is 3 characters in length.2.16.840.1.113883.5.1124
hl7V3Conformance Description: Identifies allowed codes for HL7aTMs v3 conformance property.2.16.840.1.113883.5.1125
orderableDrugForm OpenIssue: Missing description.2.16.840.1.113883.5.85
substanceAdminSubstitution Identifies what sort of change is permitted or has occurred between the therapy that was ordered and the therapy that was/will be provided.2.16.840.1.113883.5.1070

Value Sets

Name (URI = http://hl7.org/fhir/ValueSet/v3-...) NameOID
AcknowledgementCondition The codes identify the conditions under which accept acknowledgements are required to be returned in response to this message. Note that accept acknowledgement address two different issues at the same time: reliable transport as well as syntactical correctness2.16.840.1.113883.1.11.155
AcknowledgementDetailCode OpenIssue: Missing description.--
AcknowledgementDetailType A code identifying the specific message to be provided. Discussion: A textual value may be specified as the print name, or for non-coded messages, as the original text. Examples: 'Required attribute xxx is missing', 'System will be unavailable March 19 from 0100 to 0300'2.16.840.1.113883.1.11.19358
AcknowledgementType This attribute contains an acknowledgement code as described in the HL7 message processing rules. OpenIssue: Description was copied from attribute and needs to be improved to be appropriate for a code system.2.16.840.1.113883.1.11.8
ActClass**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.11527
ActClassClinicalDocument A clinical document is a documentation of clinical observations and services, with the following characteristics: (1) Persistence - A clinical document continues to exist in an unaltered state, for a time period defined by local and regulatory requirements; (2) Stewardship - A clinical document is maintained by a person or organization entrusted with its care; (3) Potential for authentication - A clinical document is an assemblage of information that is intended to be legally authenticated; (4) Wholeness - Authentication of a clinical document applies to the whole and does not apply to portions of the document without the full context of the document; (5) Human readability - A clinical document is human readable."2.16.840.1.113883.1.11.13948
ActClassDocument Specialization of Act to add the characteristics unique to document management services.2.16.840.1.113883.1.11.18938
ActClassInvestigation An formalized inquiry into the circumstances surrounding a particular unplanned event or potential event for the purposes of identifying possible causes and contributing factors for the event. This investigation could be conducted at a local institutional level or at the level of a local or national government.2.16.840.1.113883.1.11.20224
ActClassObservation Description: An act that is intended to result in new information about a subject. The main difference between Observations and other Acts is that Observations have a value attribute. Thecode attribute of Observation and thevalue attribute of Observation must be considered in combination to determine the semantics of the observation. Discussion: Structurally, many observations are name-value-pairs, where the Observation.code (inherited from Act) is the name and the Observation.value is the value of the property. Such a construct is also known as a variable (a named feature that can assume a value) hence, the Observation class is always used to hold generic name-value-pairs or variables, even though the variable valuation may not be the result of an elaborate observation method. It may be a simple answer to a question or it may be an assertion or setting of a parameter. As with all Act statements, Observation statements describe what was done, and in the case of Observations, this includes a description of what was actually observed (results or answers); and those results or answers are part of the observation and not split off into other objects. The method of action is asserted by the Observation classCode or its subclasses at the least granular level, by the Observation.code attribute value at the medium level of granularity, and by the attribute value of observation.methodCode when a finer level of granularity is required. The method in whole or in part may also appear in the attribute value of Observation.value when using coded data types to express the value of the attribute. Relevant aspects of methodology may also be restated in value when the results themselves imply or state a methodology. An observation may consist of component observations each having their own Observation.code and Observation.value. In this case, the composite observation may not have an Observation.value for itself. For instance, a white blood cell count consists of the sub-observations for the counts of the various granulocytes, lymphocytes and other normal or abnormal blood cells (e.g., blasts). The overall white blood cell count Observation itself may therefore not have a value by itself (even though it could have one, e.g., the sum total of white blood cells). Thus, as long as an Act is essentially an Act of recognizing and noting information about a subject, it is an Observation, regardless of whether it has a simple value by itself or whether it has sub-observations. Even though observations are professional acts (see Act) and as such are intentional actions, this does not require that every possible outcome of an observation be pondered in advance of it being actually made. For instance, differential white blood cell counts (WBC) rarely show blasts, but if they do, this is part of the WBC observation even though blasts might not be predefined in the structure of a normal WBC. Clinical documents commonly have Subjective and Objective findings, both of which are kinds of Observations. In addition, clinical documents commonly contain Assessments, which are also kinds of Observations. Thus, the establishment of a diagnosis is an Observation. Examples: Recording the results of a Family History Assessment Laboratory test and associated result Physical exam test and associated result Device temperature Soil lead level2.16.840.1.113883.1.11.11529
ActClassProcedure An Act whose immediate and primary outcome (post-condition) is the alteration of the physical condition of the subject. Examples: : Procedures may involve the disruption of some body surface (e.g. an incision in a surgical procedure), but they also include conservative procedures such as reduction of a luxated join, chiropractic treatment, massage, balneotherapy, acupuncture, shiatsu, etc. Outside of clinical medicine, procedures may be such things as alteration of environments (e.g. straightening rivers, draining swamps, building dams) or the repair or change of machinery etc.2.16.840.1.113883.1.11.19665
ActClassROI Regions of Interest (ROI) within a subject Act. Primarily used for making secondary observations on a subset of a subject observation. The relationship between a ROI and its referenced Act is specified through an ActRelationship of type "subject" (SUBJ), which must always be present.2.16.840.1.113883.1.11.17893
ActClassSupply Supply orders and deliveries are simple Acts that focus on the delivered product. The product is associated with the Supply Act via Participation.typeCode="product". With general Supply Acts, the precise identification of the Material (manufacturer, serial numbers, etc.) is important. Most of the detailed information about the Supply should be represented using the Material class. If delivery needs to be scheduled, tracked, and billed separately, one can associate a Transportation Act with the Supply Act. Pharmacy dispense services are represented as Supply Acts, associated with a SubstanceAdministration Act. The SubstanceAdministration class represents the administration of medication, while dispensing is supply.2.16.840.1.113883.1.11.11535
ActCode A code specifying the particular kind of Act that the Act-instance represents within its class. Constraints: The kind of Act (e.g. physical examination, serum potassium, inpatient encounter, charge financial transaction, etc.) is specified with a code from one of several, typically external, coding systems. The coding system will depend on the class of Act, such as LOINC for observations, etc. Conceptually, the Act.code must be a specialization of the Act.classCode. This is why the structure of ActClass domain should be reflected in the superstructure of the ActCode domain and then individual codes or externally referenced vocabularies subordinated under these domains that reflect the ActClass structure. Act.classCode and Act.code are not modifiers of each other but the Act.code concept should really imply the Act.classCode concept. For a negative example, it is not appropriate to use an Act.code "potassium" together with and Act.classCode for "laboratory observation" to somehow mean "potassium laboratory observation" and then use the same Act.code for "potassium" together with Act.classCode for "medication" to mean "substitution of potassium". This mutually modifying use of Act.code and Act.classCode is not permitted.--
ActConsentType Definition: The type of consent directive, e.g., to consent or dissent to collect, access, or use in specific ways within an EHRS or for health information exchange; or to disclose health information for purposes such as research.2.16.840.1.113883.1.11.19897
ActCoverageTypeCode Definition: Set of codes indicating the type of insurance policy or program that pays for the cost of benefits provided to covered parties.2.16.840.1.113883.1.11.19855
ActEncounterCode Domain provides codes that qualify the ActEncounterClass (ENC)2.16.840.1.113883.1.11.13955
ActExposureLevelCode A qualitative measure of the degree of exposure to the causative agent. This includes concepts such as "low", "medium" and "high". This quantifies how the quantity that was available to be administered to the target differs from typical or background levels of the substance.--
ActIncidentCode Set of codes indicating the type of incident or accident.2.16.840.1.113883.1.11.16508
ActInvoiceElementModifier Processing consideration and clarification codes.2.16.840.1.113883.1.11.17704
ActInvoiceGroupCode Type of invoice element that is used to assist in describing an Invoice that is either submitted for adjudication or for which is returned on adjudication results. Invoice elements of this type signify a grouping of one or more children (detail) invoice elements. They do not have intrinsic costing associated with them, but merely reflect the sum of all costing for it's immediate children invoice elements.2.16.840.1.113883.1.11.19398
ActMood OpenIssue: In Ballot 2009May, a strong Negative vote was lodged against several of the concept definitions in the vocabulary used for Act.moodCode. The vote was found "Persuasive With Mod", with the understanding that M and M would undertake a detailed review of these concept definitions for a future release of the RIM.2.16.840.1.113883.1.11.10196
ActMoodIntent An intention or plan to perform a service. Historical note: in previous RIM versions, the intent mood was captured as a separate class hierarchy, called Service_intent_or_order.2.16.840.1.113883.1.11.10199
ActMoodPredicate Any of the above service moods (e.g., event, intent, or goal) can be turned into a predicate used as a criterion to express conditionals (or queries.) However, currently we allow only criteria on service events.2.16.840.1.113883.1.11.10202
ActPharmacySupplyType Identifies types of dispensing events2.16.840.1.113883.1.11.16208
ActPriority A set of codes (e.g., for routine, emergency), specifying the urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen.--
ActReason A set of codes specifying the motivation, cause, or rationale of an Act, when such rationale is not reasonably represented as an ActRelationship of type "has reason" linking to another Act. Examples: Example reasons that might qualify for being coded in this field might be: "routine requirement", "infectious disease reporting requirement", "on patient request", "required by law".--
ActRelationshipCheckpoint**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10349
ActRelationshipConditional Specifies under what circumstances (target Act) the source-Act may, must, must not or has occurred2.16.840.1.113883.1.11.18977
ActRelationshipFulfills The source act fulfills (in whole or in part) the target act. Source act must be in a mood equal or more actual than the target act.2.16.840.1.113883.1.11.10342
ActRelationshipHasComponent A collection of sub-services as steps or subtasks performed for the source service. Services may be performed sequentially or concurrently.2.16.840.1.113883.1.11.10318
ActRelationshipJoin**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10360
ActRelationshipPertains This is a very unspecific relationship from one item of clinical information to another. It does not judge about the role the pertinent information plays.2.16.840.1.113883.1.11.10329
ActRelationshipSplit**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10355
ActRelationshipSubset <ns1:p>Used to indicate that the target of the relationship will be a filtered subset of the total related set of targets.</ns1:p><ns1:p>Used when there is a need to limit the number of components to the first, the last, the next, the total, the average or some other filtered or calculated subset.</ns1:p>2.16.840.1.113883.1.11.19613
ActRelationshipType The source is an excerpt from the target.2.16.840.1.113883.1.11.10317
ActSite An anatomical location on an organism which can be the focus of an act.--
ActStatus Codes representing the defined possible states of an Act, as defined by the Act class state machine.2.16.840.1.113883.1.11.15933
ActSubstanceAdminSubstitutionCodeNo Description Provided2.16.840.1.113883.1.11.16621
ActUSPrivacyLaw A jurisdictional mandate in the US relating to privacy. Deprecation Comment: Content moved to ActCode under _ActPrivacyLaw; use that instead.--
ActUncertainty OpenIssue: Missing Description2.16.840.1.113883.1.11.16899
AddressPartType Description: Code that specifies whether an address part names the street, city, country, postal code, post box, etc. Discussion: The hierarchical nature of these concepts shows composition. E.g. "Street Name" is part of "Street Address Line"2.16.840.1.113883.1.11.10642
AddressUse Codes that provide guidance around the circumstances in which a given address should be used.2.16.840.1.113883.1.11.190
AdministrativeGender The gender of a person used for adminstrative purposes (as opposed to clinical gender)2.16.840.1.113883.1.11.1
AmericanIndianAlaskaNativeLanguages American Indian and Alaska Native languages currently being used in the United States.--
Calendar**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.17422
CalendarCycle Calendar cycle identifiers--
CalendarType**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10682
Charset Internet Assigned Numbers Authority (IANA) Charset Types2.16.840.1.113883.1.11.14853
CodingRationale Identifies how to interpret the instance of the code, codeSystem value in a set of translations. Since HL7 (or a government body) may mandate that codes from certain code systems be sent in conformant messages, other synonyms that are sent in the translation set need to be distinguished among the originally captured source, the HL7 specified code, or some future role. When this code is NULL, it indicates that the translation is an undefined type. When valued, this property must contain one of the following values: SRC - Source (or original) code HL7 - HL7 Specified or Mandated SH - both HL7 mandated and the original code (precoordination) There may be additional values added to this value set as we work through the use of codes in messages and determine other Use Cases requiring special interpretation of the translations.2.16.840.1.113883.1.11.19250
CommunicationFunctionType Describes the type of communication function that the associated entity plays in the associated transmission.2.16.840.1.113883.1.11.16031
Compartment A named tag set for metadata used to populate a security category label field that "segments" an IT resource per policy by indicating that access and use is restricted to members of a defined community or project. (HL7 Healthcare Privacy and Security Classification System) Usage Note: This is the healthcare analog to the US Intelligence Community's concept of a Special Access Program. Compartment codes may be used in as a field value in an initiator's clearance to indicate permission to access and use an IT Resource with a security label having the same compartment value in security category label field. Map: Aligns with ISO 2382-8 definition of Compartment - "A division of data into isolated blocks with separate security controls for the purpose of reducing risk."2.16.840.1.113883.1.11.20478
CompressionAlgorithm**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10620
Confidentiality A set of codes specifying the security classification of acts and roles in accordance with the definition for concept domain "Confidentiality".--
ContainerCap The type of cap associated with a container--
ContainerSeparator A material in a blood collection container that facilites the separation of of blood cells from serum or plasma2.16.840.1.113883.1.11.14054
ContentProcessingMode Description: Identifies the order in which content should be processed.2.16.840.1.113883.1.11.19823
ContextControl A code that specifies how an ActRelationship or Participation contributes to the context of an Act, and whether it may be propagated to descendent Acts whose association allows such propagation (see also attributes Participation.contextControlCode, ActRelationship.contextControlCode, ActRelationship.contextConductionInd).2.16.840.1.113883.1.11.16478
DataOperation**** MISSING DEFINITIONS ****--
DeviceAlertLevel Domain values for the Device.Alert_levelCode2.16.840.1.113883.1.11.14066
DocumentCompletion Identifies the current completion state of a clinical document.2.16.840.1.113883.1.11.271
DocumentSectionType The type of document section. Possible values: review of systems, medical history, family history, microscopic findings, etc.2.16.840.1.113883.1.11.10871
DocumentStorage Identifies the storage status of a document.--
EducationLevel Years of education that a person has completed2.16.840.1.113883.1.11.19175
EmployeeJobClass**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.16036
EncounterAdmissionSource**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.12234
EncounterSpecialCourtesy**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.12242
EntityClass Classifies the Entity class and all of its subclasses. The terminology is hierarchical. At the top is this HL7-defined domain of high-level categories (such as represented by the Entity subclasses). Each of these terms must be harmonized and is specializable. The value sets beneath are drawn from multiple, frequently external, domains that reflect much more fine-grained typing.2.16.840.1.113883.1.11.10882
EntityClassDevice A subtype of ManufacturedMaterial used in an activity, without being substantially changed through that activity. The kind of device is identified by the code attribute inherited from Entity. Usage: This includes durable (reusable) medical equipment as well as disposable equipment.2.16.840.1.113883.1.11.11623
EntityClassLivingSubject Anything that essentially has the property of life, independent of current state (a dead human corpse is still essentially a living subject.)2.16.840.1.113883.1.11.10884
EntityClassManufacturedMaterial Corresponds to the ManufacturedMaterial class2.16.840.1.113883.1.11.13934
EntityClassOrganization A social or legal structure formed by human beings.2.16.840.1.113883.1.11.10889
EntityClassPlace A physicial place or site with its containing structure. May be natural or man-made. The geographic position of a place may or may not be constant.2.16.840.1.113883.1.11.10892
EntityClassRoot Corresponds to the Entity class2.16.840.1.113883.1.11.13922
EntityCode OpenIssue: Missing description.--
EntityDeterminer EntityDeterminer in natural language grammar is the class of words that comprises articles, demonstrative pronouns, and quantifiers. In the RIM, determiner is a structural code in the Entity class to distinguish whether any given Entity object stands for some, any one, or a specific thing.2.16.840.1.113883.1.11.10878
EntityDeterminerDetermined The described determiner is used to indicate that the given Entity is taken as a general description of a kind of thing that can be taken in whole, in part, or in multiples.2.16.840.1.113883.1.11.10879
EntityHandling**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.13988
EntityNamePartQualifier OpenIssue: Needs description2.16.840.1.113883.1.11.15888
EntityNamePartQualifierR2 Description: The qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.2.16.840.1.113883.1.11.20323
EntityNamePartType**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.15880
EntityNamePartTypeR2 Description: Indicates whether the name part is a given name, family name, prefix, suffix, etc.2.16.840.1.113883.1.11.20322
EntityNameUse**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.15913
EntityNameUseR2 Description: A set of codes advising a system or user which name in a set of names to select for a given purpose.2.16.840.1.113883.1.11.20321
EntityRisk Kinds of risks associated with the handling of the material..--
EntityStatus Codes representing the defined possible states of an Entity, as defined by the Entity class state machine.2.16.840.1.113883.1.11.16005
EquipmentAlertLevel**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10896
Ethnicity In the United States, federal standards for classifying data on ethnicity determine the categories used by federal agencies and exert a strong influence on categorization by state and local agencies and private sector organizations. The federal standards do not conceptually define ethnicity, and they recognize the absence of an anthropological or scientific basis for ethnicity classification. Instead, the federal standards acknowledge that ethnicity is a social-political construct in which an individual's own identification with a particular ethnicity is preferred to observer identification. The standards specify two minimum ethnicity categories: Hispanic or Latino, and Not Hispanic or Latino. The standards define a Hispanic or Latino as a person of "Mexican, Puerto Rican, Cuban, South or Central America, or other Spanish culture or origin, regardless of race." The standards stipulate that ethnicity data need not be limited to the two minimum categories, but any expansion must be collapsible to those categories. In addition, the standards stipulate that an individual can be Hispanic or Latino or can be Not Hispanic or Latino, but cannot be both.--
ExposureMode Code for the mechanism by which the exposure agent was exchanged or potentially exchanged by the participants involved in the exposure.--
FamilyMember A relationship between two people characterizing their "familial" relationship2.16.840.1.113883.1.11.19579
GTSAbbreviation**** MISSING DEFINITIONS ****--
GenderStatus**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.11523
GeneralPurposeOfUse Supports communication of purpose of use at a general level.2.16.840.1.113883.1.11.20449
HL7UpdateMode The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.2.16.840.1.113883.1.11.10018
HtmlLinkType HtmlLinkType values are drawn from HTML 4.0 and describe the relationship between the current document and the anchor that is the target of the link2.16.840.1.113883.1.11.11017
HumanLanguage Codes for the representation of the names of human languages.2.16.840.1.113883.1.11.11526
IdentifierReliability Specifies the reliability with which the identifier is known. This attribute MAY be used to assist with identifier matching algorithms.2.16.840.1.113883.1.11.20277
IdentifierScope Description: Codes to specify the scope in which the identifier applies to the object with which it is associated, and used in the datatype property II.2.16.840.1.113883.1.11.20276
InformationSensitivityPolicy Sensitivity codes are not useful for interoperability outside of a policy domain because sensitivity policies are typically localized and vary drastically across policy domains even for the same information category because of differing organizational business rules, security policies, and jurisdictional requirements. For example, an "employee" sensitivity code would make little sense for use outside of a policy domain. "Taboo" would rarely be useful outside of a policy domain unless there are jurisdictional requirements requiring that a provider disclose sensitive information to a patient directly. Sensitivity codes may be more appropriate in a legacy system's Master Files in order to notify those who access a patient's orders and observations about the sensitivity policies that apply. Newer systems may have a security engine that uses a sensitivity policy's criteria directly. The specializable Sensitivity Act.code may be useful in some scenarious if used in combination with a sensitivity identifier and/or Act.title.2.16.840.1.113883.1.11.20428
IntegrityCheckAlgorithm**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.17385
LanguageAbilityMode A value representing the method of expression of the language. Example: Expressed spoken, expressed written, expressed signed, received spoken, received written, received signed. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.1.11.12249
LanguageAbilityProficiency A value representing the level of proficiency in a language. Example: Excellent, good, fair, poor. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.1.11.12199
LivingArrangement A code depicting the living arrangements of a person--
LocalMarkupIgnore Tells a receiver to ignore just the local markup tags (local_markup, local_header, local_attr) when value="markup", or to ignore the local markup tags and all contained content when value="all"2.16.840.1.113883.1.11.10975
LocalRemoteControlState**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10893
ManagedParticipationStatus Codes representing the defined possible states of a Managed Participation, as defined by the Managed Participation class state machine.2.16.840.1.113883.1.11.15992
MapRelationship The closeness or quality of the mapping between the HL7 concept (as represented by the HL7 concept identifier) and the source coding system. The values are patterned after the similar relationships used in the UMLS Metathesaurus. Because the HL7 coding sy2.16.840.1.113883.1.11.11052
MaritalStatus * * * No description supplied * * * Open Issue: The specific meanings of these codes can vary somewhat by jurisdiction and implementation so caution should be used when determining equivalency.--
MessageWaitingPriority Indicates that the receiver has messages for the sender OpenIssue: Description does not make sense relative to name of coding system. Must be reviewed and improved.--
MilitaryRoleType Definition: A person playing the role of program eligible under a program based on military status. Discussion: This CoveredPartyRoleType.code is typically used when the CoveredPartyRole class code is either "program eligible" or "subscriber" and the person's status as a member of the military meets jurisdictional or program criteria2.16.840.1.113883.1.11.19812
ModifyIndicator**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.395
NullFlavor A collection of codes specifying why a valid value is not present.2.16.840.1.113883.1.11.10609
ObligationPolicy Conveys the mandated workflow action that an information custodian, receiver, or user must perform. Examples: encrypt Usage Note: Per OASIS XACML, an obligation is an operation specified in a policy or policy that is performed in conjunction with the enforcement of an access control decision.2.16.840.1.113883.1.11.20445
ObservationInterpretation One or more codes specifying a rough qualitative interpretation of the observation, such as "normal", "abnormal", "below normal", "change up", "resistant", "susceptible", etc. OpenIssue: Description copied from Concept Domain of same name. Must be verified. Note also that this might be identical to the V2 code system of interpretation codes (formerly Abnormal Flags in older versions).2.16.840.1.113883.1.11.78
ObservationMethod A code that provides additional detail about the means or technique used to ascertain the observation. Examples: Blood pressure measurement method: arterial puncture vs. sphygmomanometer (Riva-Rocci), sitting vs. supine position, etc. OpenIssue: Description copied from Concept Domain of same name. Must be verified. Note that the Domain has a full discussion about use of the attribute and constraining that is not appropriate for the code system description. Needs to be improved.2.16.840.1.113883.1.11.20423
ObservationType Identifies the kinds of observations that can be performed2.16.840.1.113883.1.11.16226
ObservationValue This domain is the root domain to which all HL7-recognized value sets for the Observation.value attribute will be linked when Observation.value has a coded data type. OpenIssue: Description copied from Concept Domain of same name. Must be corrected..--
ParticipationFunction This code is used to specify the exact function an actor had in a service in all necessary detail. This domain may include local extensions (CWE).2.16.840.1.113883.1.11.10267
ParticipationIndirectTarget Target that is not substantially present in the act and which is not directly affected by the act, but which will be a focus of the record or documentation of the act.2.16.840.1.113883.1.11.19032
ParticipationInformationGenerator Parties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g., consultant), information that the Act itself seeks to reveal (e.g., informant of clinical history), or information about what Act was performed (e.g., informant witness).2.16.840.1.113883.1.11.10251
ParticipationInformationTranscriber An entity entering the data into the originating system. The data entry entity is collected optionally for internal quality control purposes. This includes the transcriptionist for dictated text transcribed into electronic form.2.16.840.1.113883.1.11.19676
ParticipationMode A set of codes specifying the modality by which the Entity playing the Role is participating in the Act. Examples: Physically present, over the telephone, written communication. Rationale: Particularly for author (originator) participants this is used to specify whether the information represented by the act was initially provided verbally, (hand-)written, or electronically. Open Issue: There needs to be a reexamination of the hierarchies as there seems to be some muddling between ELECTRONIC and other concepts that involve electronic communication that are in other hierarchies.--
ParticipationPhysicalPerformer A person who actually and principally carries out the action. Need not be the principal responsible actor, e.g. a surgery resident operating under supervision of attending surgeon, and may be the patient in self-care, e.g. fingerstick blood sugar. The traditional order filler is a performer. This information should accompany every service event.2.16.840.1.113883.1.11.10248
ParticipationSignature A set of codes specifying whether and how the participant has attested his participation through a signature and or whether such a signature is needed. Examples: A surgical Procedure act object (representing a procedure report) requires a signature of the performing and responsible surgeon, and possibly other participants. (See also: Participation.signatureText.)2.16.840.1.113883.1.11.10282
ParticipationTargetDirect Target that is substantially present in the service and which is directly affected by the service action (includes consumed material, devices, etc.).2.16.840.1.113883.1.11.10286
ParticipationTargetLocation The facility where the service is done. May be a static building (or room therein) or a moving location (e.g., ambulance, helicopter, aircraft, train, truck, ship, etc.)2.16.840.1.113883.1.11.10302
ParticipationTargetSubject The principle target that the service acts on. E.g. the patient in physical examination, a specimen in a lab observation. May also be a patient's family member (teaching) or a device or room (cleaning, disinfecting, housekeeping). Note: not all direct targets are subjects, consumables, and devices used as tools for a service are not subjects. However, a device may be a subject of a maintenance service.2.16.840.1.113883.1.11.19584
ParticipationType**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10901
ParticipationVerifier A person who verifies the correctness and appropriateness of the service (plan, order, event, etc.) and hence takes on accountability.2.16.840.1.113883.1.11.10259
PatientImportance Patient VIP code2.16.840.1.113883.1.11.19265
PaymentTerms Describes payment terms for a financial transaction, used in an invoice. This is typically expressed as a responsibility of the acceptor or payor of an invoice.2.16.840.1.113883.1.11.14908
PersonDisabilityType A code identifying a person's disability.--
PersonalRelationshipRoleType Types of personal relationships between two living subjects. Example: Parent, sibling, unrelated friend, neighbor2.16.840.1.113883.1.11.19563
ProbabilityDistributionType**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10747
ProcessingID Codes used to specify whether a message is part of a production, training, or debugging system.2.16.840.1.113883.1.11.103
ProcessingMode**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.207
ProvenanceEventCurrentState Specifies the state change of a target Act, such as a document or an entry, from its previous state as a predecessor Act. For example, if the target Act is the result of a predecessor Act being "obsoleted" and replaced with the target Act, the source ProvenanceEventCurrentState Act code would be "obsoleted".2.16.840.1.113883.1.11.20547
ProvenanceEventCurrentState-AS Specifies the state change of a target Act, using ActStatus codes, from its previous state as a predecessor Act. For example, if the target Act is the result of a predecessor Act being "obsoleted" and replaced with the target Act, the source ProvenanceEventCurrentState Act code would be "obsoleted".2.16.840.1.113883.1.11.20545
ProvenanceEventCurrentState-DC Specifies the state change of a target Act using DocuymentCompletion codes, from its previous state as a predecessor Act. For example, if the target Act is the result of a predecessor Act being "obsoleted" and replaced with the target Act, the source ProvenanceEventCurrentState Act code would be "obsoleted".2.16.840.1.113883.1.11.20546
PurposeOfUse Supports communication of purpose of use at a general level.2.16.840.1.113883.1.11.20448
QueryParameterValue The domain of coded values used as parameters within QueryByParameter queries.--
QueryPriority**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.91
QueryRequestLimit Definition: Defines the units associated with the magnitude of the maximum size limit of a query response that can be accepted by the requesting application.--
QueryResponse A code classifying the general nature of the response to a given query. Includes whether or not data was found, or whether an error occurred.2.16.840.1.113883.1.11.208
QueryStatusCode A code specifying the state of the Query.2.16.840.1.113883.1.11.18899
Race In the United States, federal standards for classifying data on race determine the categories used by federal agencies and exert a strong influence on categorization by state and local agencies and private sector organizations. The federal standards do not conceptually define race, and they recognize the absence of an anthropological or scientific basis for racial classification. Instead, the federal standards acknowledge that race is a social-political construct in which an individual's own identification with one more race categories is preferred to observer identification. The standards use a variety of features to define five minimum race categories. Among these features are descent from "the original peoples" of a specified region or nation. The minimum race categories are American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, and White. The federal standards stipulate that race data need not be limited to the five minimum categories, but any expansion must be collapsible to those categories.--
RefrainPolicy Conveys prohibited actions which an information custodian, receiver, or user is not permitted to perform unless otherwise authorized or permitted under specified circumstances. Examples: prohibit redisclosure without consent directive2.16.840.1.113883.1.11.20446
RelationalOperator**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.209
RelationshipConjunction**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10365
ReligiousAffiliation Assigment of spiritual faith affiliation--
ResponseLevel Specifies whether a response is expected from the addressee of this interaction and what level of detail that response should include2.16.840.1.113883.1.11.14761
ResponseModality Defines the timing and grouping of the response instances. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.1.11.394
ResponseMode Specifies the mode, immediate versus deferred or queued, by which a receiver should communicate its receiver responsibilities.2.16.840.1.113883.1.11.19650
RoleClass Codes for the Role class hierarchy. The values in this hierarchy, represent a Role which is an association or relationship between two entities - the entity that plays the role and the entity that scopes the role. Roles names are derived from the name of the playing entity in that role. The role hierarchy stems from three core concepts, or abstract domains: RoleClassOntological is an abstract domain that collects roles in which the playing entity is defined or specified by the scoping entity. RoleClassPartitive collects roles in which the playing entity is in some sense a "part" of the scoping entity. RoleClassAssociative collects all of the remaining forms of association between the playing entity and the scoping entity. This set of roles is further partitioned between: RoleClassPassive which are roles in which the playing entity is used, known, treated, handled, built, or destroyed, etc. under the auspices of the scoping entity. The playing entity is passive in these roles in that the role exists without an agreement from the playing entity. RoleClassMutualRelationship which are relationships based on mutual behavior of the two entities. The basis of these relationship may be formal agreements or they may bede facto behavior. Thus, this sub-domain is further divided into: RoleClassRelationshipFormal in which the relationship is formally defined, frequently by a contract or agreement. Personal relationship which inks two people in a personal relationship. The hierarchy discussed above is represented In the current vocabulary tables as a set of abstract domains, with the exception of the "Personal relationship" which is a leaf concept. OpenIssue: Description copied from Concept Domain of same name. Must be verified.2.16.840.1.113883.1.11.11555
RoleClassAgent An entity (player) that acts or is authorized to act on behalf of another entity (scoper).2.16.840.1.113883.1.11.14006
RoleClassAssociative A general association between two entities that is neither partitive nor ontological.2.16.840.1.113883.1.11.19313
RoleClassManufacturedProduct Scoped by the manufacturer2.16.840.1.113883.1.11.11580
RoleClassMutualRelationship A relationship that is based on mutual behavior of the two Entities as being related. The basis of such relationship may be agreements (e.g., spouses, contract parties) or they may bede facto behavior (e.g. friends) or may be an incidental involvement with each other (e.g. parties over a dispute, siblings, children).2.16.840.1.113883.1.11.19316
RoleClassPartitive An association between two Entities where the playing Entity is considered in some way "part" of the scoping Entity, e.g., as a member, component, ingredient, or content. Being "part" in the broadest sense of the word can mean anything from being an integral structural component to a mere incidental temporary association of a playing Entity with a (generally larger) scoping Entity.2.16.840.1.113883.1.11.10429
RoleClassPassive An association for a playing Entity that is used, known, treated, handled, built, or destroyed, etc. under the auspices of the scoping Entity. The playing Entity is passive in these roles (even though it may be active in other roles), in the sense that the kinds of things done to it in this role happen without an agreement from the playing Entity.2.16.840.1.113883.1.11.19105
RoleClassRelationshipFormal A relationship between two entities that is formally recognized, frequently by a contract or similar agreement.2.16.840.1.113883.1.11.10416
RoleClassRoot Corresponds to the Role class2.16.840.1.113883.1.11.13940
RoleClassServiceDeliveryLocation A role played by a place at which services may be provided.2.16.840.1.113883.1.11.16927
RoleClassSpecimen A role played by a material entity that is a specimen for an act. It is scoped by the source of the specimen.2.16.840.1.113883.1.11.11591
RoleCode A set of codes further specifying the kind of Role; specific classification codes for further qualifying RoleClass codes.--
RoleLinkStatus Description: Codes representing possible states of a RoleLink, as defined by the RoleLink class state machine.2.16.840.1.113883.1.11.20413
RoleLinkType**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.11603
RoleStatus Codes representing the defined possible states of an Role, as defined by the Role class state machine.2.16.840.1.113883.1.11.15999
RouteOfAdministration The path the administered medication takes to get into the body or into contact with the body.--
SecurityControlObservationValue Security observation values used to indicate security control metadata. V:SecurityControl is the union of V:SecurityPolicy,V:ObligationPolicy, V:RefrainPolicy, V:PurposeOfUse, and V:GeneralPurpose of Use used to populate the SecurityControlObservationValue attribute in order to convey one or more nonhierarchical security control metadata dictating handling caveats, purpose of use, dissemination controls and other refrain policies, and obligations to which a custodian or receiver is required to comply.2.16.840.1.113883.1.11.20471
SecurityIntegrityObservationValueNo Description Provided2.16.840.1.113883.1.11.20481
SecurityPolicy Types of security policies that further specify the ActClassPolicy value set. Examples: encrypt prohibit redisclosure without consent directive2.16.840.1.113883.1.11.20444
Sequencing Specifies sequence of sort order.2.16.840.1.113883.1.11.390
ServiceDeliveryLocationRoleType A role of a place that further classifies the setting (e.g., accident site, road side, work site, community location) in which services are delivered.2.16.840.1.113883.1.11.17660
SetOperator**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.17416
SeverityObservation Potential values for observations of severity.2.16.840.1.113883.1.11.16643
SpecimenType**** MISSING DEFINITIONS ****--
SubstanceAdminSubstitutionReasonNo Description Provided2.16.840.1.113883.1.11.19377
SubstitutionCondition Identifies what sort of change is permitted or has occurred between the item that was ordered/requested and the one that was/will be provided.--
TableCellHorizontalAlign These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.1.11.10981
TableCellScope These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.1.11.11012
TableCellVerticalAlign These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.1.11.10987
TableFrame These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.1.11.10992
TableRules These values are defined within the XHTML 4.0 Table Model2.16.840.1.113883.1.11.11002
TargetAwareness**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10310
TelecommunicationCapabilities Description: Concepts that define the telecommunication capabilities of a particular device. Used to identify the expected capabilities to be found at a particular telecommunication address.2.16.840.1.113883.1.11.20312
TimingEvent**** MISSING DEFINITIONS ****2.16.840.1.113883.1.11.10706
TransmissionRelationshipTypeCode Description: A code specifying the meaning and purpose of every TransmissionRelationship instance. Each of its values implies specific constraints to what kinds of Transmission objects can be related and in which way.2.16.840.1.113883.1.11.19833
TribalEntityUS INDIAN ENTITIES RECOGNIZED AND ELIGIBLE TO RECEIVE SERVICES FROM THE UNITED STATES BUREAU OF INDIAN AFFAIRS--
VaccineManufacturer The manufacturer of a vaccine.2.16.840.1.113883.1.11.227
VerificationMethodNo Description Provided2.16.840.1.113883.1.11.19707
hl7Realm Description: Coded concepts representing Binding Realms (used for Context Binding of terminology in HL7 models) and/or Namespace Realms (used to help ensure unique identification of HL7 artifacts). This code system is partitioned into three sections: Affiliate realms, Binding realms and Namespace realms. All affiliate realm codes may automatically be used as both binding realms and namespace realms. Furthermore, affiliate realms are the only realms that have authority over the creation of binding realms. (Note that 'affiliate' includes the idea of both international affiliates and the HL7 International organization.) All other codes must be associated with an owning affiliate realm and must appear as a specialization of _BindingRealm or _NamespaceRealm. For affiliates whose concepts align with nations, the country codes from ISO 3166-1 2-character alpha are used for the code when possible so these codes should not be used for other realm types. It is recommended that binding realm and namespace codes submitted by affiliates use the realm code as a prefix to avoid possible collisions with ISO codes. However, tooling does not currently support namepace realm codes greater than 2 characters. Open Issue: The name of the concept property "owningAffiliate" should be changed to better reflect that the property value is the human readable name of the organizational entity that manages the Realm identified by the Realm Code. Open Issue: In spite of the inability of tooling to process codes longer than 2 characters, there is at least one realm codes ('SOA') that was added that is 3 characters in length.2.16.840.1.113883.1.11.20355
hl7V3Conformance Description: Identifies allowed codes for HL7aTMs v3 conformance property.--
orderableDrugForm OpenIssue: Missing description.--
substanceAdminSubstitution Identifies what sort of change is permitted or has occurred between the therapy that was ordered and the therapy that was/will be provided.--
xBasicConfidentialityKind Description: Used to enumerate the typical confidentiality constraints placed upon a clinical document. Usage Note: x_BasicConfidentialityKind is a subset of Confidentiality codes that are used as metadata indicating the receiver responsibility to comply with normally applicable jurisdictional privacy law or disclosure authorization; that the receiver may not disclose this information except as directed by the information custodian, who may be the information subject; or that the receiver may not disclose this information except as directed by the information custodian, who may be the information subject.2.16.840.1.113883.1.11.16926