1.22.4.0 HL7 Version 3 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 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 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/…) | Description | OID |
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 correctness | – |
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’ | – |
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. | – |
ActClass | ? not found | – |
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. | – |
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. | – |
ActInvoiceElementModifier | Processing consideration and clarification codes. | – |
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. | – |
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 | ? not found | – |
ActRelationshipJoin | ? not found | – |
ActRelationshipSplit | ? not found | – |
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> | – |
ActRelationshipType | The source is an excerpt from the target. | – |
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. | – |
ActUSPrivacyLaw | Description: A jurisdictional mandate in the US relating to privacy. | – |
ActUncertainty | OpenIssue: Missing Description | – |
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" | – |
AddressUse | Description: Uses of Addresses. Lloyd to supply more complete description. | – |
AdministrativeGender | The gender of a person used for adminstrative purposes (as opposed to clinical gender) | – |
AmericanIndianAlaskaNativeLanguages | American Indian and Alaska Native languages currently being used in the United States. | – |
Calendar | ? not found | – |
CalendarCycle | Calendar cycle identifiers | – |
CalendarType | ? not found | – |
Charset | Internet Assigned Numbers Authority (IANA) Charset Types | – |
CodeSystem | Code systems used in HL7 standards. | – |
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. | – |
CommunicationFunctionType | Describes the type of communication function that the associated entity plays in the associated transmission. | – |
CompressionAlgorithm | ? not found | – |
ConceptCodeRelationship | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
ConceptGenerality | Indicates whether the concept that is the target should be interpreted as itself, or whether it should be expanded to include its child concepts, or both when it is included in the source domain/valueset. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
ConceptProperty | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
ConceptStatus | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
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 plasma | – |
ContentProcessingMode | Description: Identifies the order in which content should be processed. | – |
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). | – |
Currency | The currency unit as defined in ISO 4217. Created prior to ISO ruling on OIDs for ISO code tables defined in ISO standards. Retired. Replaced by 1.0.4217 iso4217. | – |
DataOperation | ? not found | – |
DataType | Code system retired. | – |
DeviceAlertLevel | Domain values for the Device.Alert_levelCode | – |
DocumentCompletion | Identifies the current completion state of a clinical document. | – |
DocumentStorage | Identifies the storage status of a document. | – |
EditStatus | The status of an entry as it pertains to its review and incorporation into the HL7 domain specification database. | – |
EducationLevel | Years of education that a person has completed | – |
EmployeeJobClass | ? not found | – |
EncounterAccident | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. No content. | – |
EncounterAcuity | The level of resource intensiveness of patient care. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. No content. | – |
EncounterAdmissionSource | ? not found | – |
EncounterReferralSource | This domain is defined in UB92 and applies to US realm only Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. We’ve deprecated all of the codes. | – |
EncounterSpecialCourtesy | ? not found | – |
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. | – |
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. | – |
EntityHandling | ? not found | – |
EntityNamePartQualifier | OpenIssue: Needs description | – |
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. | – |
EntityNamePartType | ? not found | – |
EntityNamePartTypeR2 | Description: Indicates whether the name part is a given name, family name, prefix, suffix, etc. | – |
EntityNameUse | ? not found | – |
EntityNameUseR2 | Description: A set of codes advising a system or user which name in a set of names to select for a given purpose. | – |
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. | – |
EquipmentAlertLevel | ? not found | – |
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. | – |
GTSAbbreviation | ? not found | – |
GenderStatus | ? not found | – |
HL7CommitteeIDInRIM | Holds the codes used to identify the committees and SIGS of HL7 in RIM repository tables. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
HL7ConformanceInclusion | These concepts represent theconformance requirments defined for including or valuing an element of an HL7 message. The concepts apply equally to conformance profiles defined for Version 2.x messgaes as defined by the Conformance SIG, and to the conformance columns for Version 3 messages as specified in the HMD. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
HL7DefinedRoseProperty | The property Ids that HL7 has defined for customizing Rational Rose. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
HL7UpdateMode | The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute. | – |
HealthcareProviderTaxonomyHIPAA | ? not found | – |
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 link | – |
IdentifierReliability | Specifies the reliability with which the identifier is known. This attribute MAY be used to assist with identifier matching algorithms. | – |
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. | – |
IntegrityCheckAlgorithm | ? not found | – |
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. | – |
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. | – |
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" | – |
LocalRemoteControlState | ? not found | – |
MDFAttributeType | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
MDFSubjectAreaPrefix | The standard prefixes used in Rose for RIM subject areas that determine the role or function of each subject area. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
ManagedParticipationStatus | Codes representing the defined possible states of a Managed Participation, as defined by the Managed Participation class state machine. | – |
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 sy | – |
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. | – |
MaterialForm | A value representing the state (solid, liquid, gas) and nature of the material. Open Issue:There exist no codes in the repository for this coding system; should it be removed? | – |
MaterialType | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. This is outside the hierarchy and there’s already an equivalent domain MaterialEntityClass in the right hierarchy. The corresponding code system is empty. | – |
MdfHmdMetSourceType | Code to identify the source of a Message Element Type represented in the ‘of MET’ column of an HMD. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
MdfHmdRowType | The row type codes for the tabular representation of a Hierarchical Message Description. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
MdfRmimRowType | The row types for the tabular representation of an R-MIM. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
MessageCondition | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used.This isn’t referenced in the RIM and is a copy of old v2 codes. It’s superseded by AcknowledgementDetailCode | – |
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. | – |
ModifyIndicator | ? not found | – |
NullFlavor | A collection of codes specifying why a valid value is not present. | – |
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). | – |
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. | – |
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.. | – |
OrganizationNameType | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. All of these are maintained under EntityNameType. This was created in error and should never be used. | – |
ParameterizedDataType | Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. | – |
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). | – |
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. | – |
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.) | – |
ParticipationType | ? not found | – |
PatientImportance | Patient VIP code | – |
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. | – |
PeriodicIntervalOfTimeAbbreviation | ? not found | – |
PersonDisabilityType | A code identifying a person’s disability. | – |
PostalAddressUse | Deprecation Comment: This code system was deprecated as of the November 2007 harmonization meeting. The content was folded into AddressUse (2.16.840.1.113883.5.1119), which replaces this code system. | – |
ProbabilityDistributionType | ? not found | – |
ProcedureMethod | Identifies the technique used to perform a procedure. | – |
ProcessingID | Codes used to specify whether a message is part of a production, training, or debugging system. | – |
ProcessingMode | ? not found | – |
QueryParameterValue | The domain of coded values used as parameters within QueryByParameter queries. | – |
QueryPriority | ? not found | – |
QueryQuantityUnit | Values in this domain specify the units of a query quantity limited request. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used. This is a holdover. It is not referenced. It is superseded by QueryRequestLimit. | – |
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. | – |
QueryStatusCode | A code specifying the state of the Query. | – |
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. | – |
RelationalOperator | ? not found | – |
RelationshipConjunction | ? not found | – |
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 include | – |
ResponseModality | Defines the timing and grouping of the response instances. OpenIssue: Description copied from Concept Domain of same name. Must be verified. | – |
ResponseMode | Specifies the mode, immediate versus deferred or queued, by which a receiver should communicate its receiver responsibilities. | – |
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. | – |
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. | – |
RoleLinkType | ? not found | – |
RoleStatus | Codes representing the defined possible states of an Role, as defined by the Role class state machine. | – |
RouteOfAdministration | The path the administered medication takes to get into the body or into contact with the body. | – |
Sequencing | Specifies sequence of sort order. | – |
SetOperator | ? not found | – |
SpecialArrangement | A code indicating the type of special arrangements provided for a patient encounter (e.g., wheelchair, stretcher, interpreter, attendant, seeing eye dog). For encounters in intention moods, this information can be used to identify special arrangements that will need to be made for the incoming patient. | – |
SpecimenType | ? not found | – |
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 Model | – |
TableCellScope | These values are defined within the XHTML 4.0 Table Model | – |
TableCellVerticalAlign | These values are defined within the XHTML 4.0 Table Model | – |
TableFrame | These values are defined within the XHTML 4.0 Table Model | – |
TableRules | These values are defined within the XHTML 4.0 Table Model | – |
TargetAwareness | ? not found | – |
TelecommunicationAddressUse | Deprecation Comment: This code system was deprecated as of the November 2007 harmonization meeting. The content was folded into AddressUse (2.16.840.1.113883.5.1119), which replaces this code system. | – |
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. | – |
TimingEvent | ? not found | – |
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. | – |
TribalEntityUS | INDIAN ENTITIES RECOGNIZED AND ELIGIBLE TO RECEIVE SERVICES FROM THE UNITED STATES BUREAU OF INDIAN AFFAIRS | – |
VaccineManufacturer | The manufacturer of a vaccine. | – |
VaccineType | The kind of vaccine. | – |
VocabularyDomainQualifier | Vocabulary domain qualifiers are concepts that are used in domain constraints to specify behavior of the new domain. Code system retired. | – |
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. | – |
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. | – |
Value Sets
Name (URI = http://hl7.org/fhir/v3/vs/…) | Name | OID |
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 |
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 |
ActPharmacySupplyType | Identifies types of dispensing events | 2.16.840.1.113883.1.11.16208 |
ActSubstanceAdminSubstitutionCode | ?? | 2.16.840.1.113883.1.11.16621 |
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 |
FamilyMember | A relationship between two people characterizing their "familial" relationship | 2.16.840.1.113883.1.11.19579 |
GeneralPurposeOfUse | Supports communication of purpose of use at a general level. | 2.16.840.1.113883.1.11.20449 |
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 |
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 criteria | 2.16.840.1.113883.1.11.19812 |
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 |
ObservationType | Identifies the kinds of observations that can be performed | 2.16.840.1.113883.1.11.16226 |
PersonalRelationshipRoleType | Types of personal relationships between two living subjects. Example: Parent, sibling, unrelated friend, neighbor | 2.16.840.1.113883.1.11.19563 |
PurposeOfUse | Supports communication of purpose of use at a general level. | 2.16.840.1.113883.1.11.20448 |
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 directive | 2.16.840.1.113883.1.11.20446 |
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 |
SecurityIntegrityObservationValue | ?? | 2.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 directive | 2.16.840.1.113883.1.11.20444 |
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 |
SeverityObservation | Potential values for observations of severity. | 2.16.840.1.113883.1.11.16643 |
SubstanceAdminSubstitutionReason | ?? | 2.16.840.1.113883.1.11.19377 |
VerificationMethod | ?? | 2.16.840.1.113883.1.11.19707 |
x_BasicConfidentialityKind | 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 |