Concept Domain Definitions

This HTML document contains the definition of all HL7 Concept Domains. They are displayed as tables, with one table for each Concept Domain that is not a specialization of another Concept Domain. Within each table are listed the "host" Concept Domain, and each of the concept domains that specialize it, as well as their specializations. The tables contain four columns:

  1. The level (or depth) of the specialization in that row.
  2. The name of the Concept Domain (indented according to the specialization level). Value Set bindings, if any, are shown in italics beneath the Concept Domain Name, and the binding realm and coding strength are listed in parentheses after the Value Set name
  3. The RIM attribute (if any) for which this Concept domain provides a constraint, along with its data type in parentheses.
  4. The textual definition of the Concept Domain.
AcknowledgementCondition     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AcknowledgementCondition
 AcknowledgementCondition (UV as CNE)
Message .acceptAckCode (CS)

Definition:

Acknowledgement Condition codes describe the conditions under which accept or application level acknowledgements are required to be returned in response to the message send operation.


Return to concept domain index
AcknowledgementDetailCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AcknowledgementDetailCode
 AcknowledgementDetailCode (C1 as CWE)
AcknowledgementDetail .code (CD)

Definition:

A site specific code indicating the specific problem being reported by this Ack Detail.

1 AcknowledgementDetailNotSupportedCode
 AcknowledgementDetailNotSupportedCode (C1 as CWE)

Definition:

Refelects rejections because elements of the communication are not supported in the current context.

1 AcknowledgementDetailSyntaxErrorCode
 AcknowledgementDetailSyntaxErrorCode (C1 as CWE)

Definition:

Reflects errors in the syntax or structure of the communication.


Return to concept domain index
AcknowledgementDetailType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AcknowledgementDetailType
 AcknowledgementDetailType (UV as CNE)
AcknowledgementDetail .typeCode (CS)

Definition:

A code identifying the specific message to be provided.

A textual value may be specified as the print name, or for non-coded messages, as the original text.Discussion:

'Required attribute xxx is missing', 'System will be unavailable March 19 from 0100 to 0300'Examples:

1 AcknowledgmentMessageType

Definition:

Identifies the the kind of information specified in the acknowledgement message. Options are: Error, Warning or Information.


Return to concept domain index
AcknowledgementType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AcknowledgementType
 AcknowledgementType (UV as CNE)
Acknowledgement .typeCode (CS)

Definition:

Acknowledgement code as described in HL7 message processing rules.


Return to concept domain index
ActAppointmentType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActAppointmentType

Definition:

Description: Types of acts that can be scheduled.

Examples:

  • Follow-up appointment
  • New referral appointment
  • Consultation appointment
  • Specimen Collection appointment
  • Procedure appointment

Return to concept domain index
ActClass     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActClass
 ActClass (UV as CNE)
Act .classCode (CS)

Definition:

A code specifying the major type of Act that this Act-instance represents.

Constraints: The classCode domain is a tightly controlled vocabulary, not an external or user-defined vocabulary.

Every Act-instance must have a classCode. If the act class is not further specified, the most general Act.classCode (ACT) is used.

The Act.classCode must be a generalization of the specific Act concept (e.g., as expressed in Act.code), in other words, the Act concepts conveyed in an Act must be specializations of the Act.classCode. Especially, Act.code is not a "modifier" that can alter the meaning of a class code. (See Act.code for contrast.)

1 ActClassExposure
 ActClassExposure (C1 as CNE)

Definition:

Description:The interaction of entities whereupon a subject entity is brought into proximity to a physical, chemical or biological agent. This includes intended exposure (e.g. administering a drug product) as well as accidental or environmental exposure. (Note: This class deals only with proximity and not the effectiveness of the exposure, i.e. not all exposed will suffer actual harm or benefit.)

Examples:Exposure to radiation, drug administration, inhalation of peanut aerosol or viral particles.

1 ActClassGenomicObservation
 ActClassGenomicObservation (C1 as CNE)

Definition:

Description:An observation of genomic phenomena.

1 ActClassPolicy
 ActClassPolicy (C1 as CNE)

Definition:

Description:A mandate, regulation, obligation, requirement, rule, or expectation unilaterally imposed by one party on:

  • The activity of another party

  • The behavior of another party

  • The manner in which an act is executed

1 ActClassProcedure
 ActClassProcedure (C1 as CNE)

Definition:

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.

1 ActClassStorage
 ActClassStorage (C1 as CNE)

Definition:

The act of putting something away for safe keeping. The "something" may be physical object such as a specimen, or information, such as observations regarding a specimen.

1 SubjectPhysicalPosition

Definition:

The spatial relationship of a subject whether human, other animal, or plant, to a frame of reference such as gravity or a collection device.

2 . . ImagingSubjectOrientation DiagnosticImage .subjectOrientationCode (CD)

Definition:

A code specifying qualitatively the spatial relation between imaged object and imaging film or detector.

2 . . SubjectBodyPosition
. .   ActClassSubjectBodyPosition (C1 as CNE)

Definition:

Contains codes for defining the observed, physical position of a subject, such as during an observation, assessment, collection of a specimen, etc. ECG waveforms and vital signs, such as blood pressure, are two examples where a general, observed position typically needs to be noted.


Return to concept domain index
ActCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActCode Act .code (CD)

Definition:

The table that provides the detailed or rich codes for the Act classes.

1 ActAccountType
 ActAccountCode (R1 as CWE)

Definition:

Description: Types of representation groupings of financial transactions that are tracked and reported together with a single balance.

Examples:

  • Patient billing accounts

  • Cost center

  • Cash

Property:   ConceptualSpaceForClassCode: ActClass.ACCT

1 ActAdjudicationType
 ActAdjudicationCode (R1 as CWE)

Definition:

Description: Types of responses that will occur as a result of the adjudication of an electronic invoice at a summary level and provides guidance on interpretation of the referenced adjudication results.

Examples:

  • adjudicated with adjustments

  • adjudicated as refused

  • adjudicated as submitted

Property:   ConceptualSpaceForClassCode: ActClass.ADJUD

2 . . ActAdjudicationInformationCode

Definition:

Explanatory codes that provide information derived by an Adjudicator during the course of adjudicating an Invoice. Codes from this domain are purely information and do not materially affect the adjudicated Invoice. That is, codes do not impact or explain financial adjustments to an Invoice.

A companion domain (ActAdjudicationReason) includes information reasons which have a financial impact on an Invoice (claim).

Example adjudication information code is 54540 - Patient has reached Plan Maximum for current year.

Codes from this domain further rationalizes ActAdjudicationCodes (e.g. AA - Adjudicated with Adjustment), which are used to describe the process of adjudicating an Invoice.

Property:   ConceptualSpaceForClassCode: ActClass.ADJUD

2 . . ActAdjudicationResultActionType
. .   ActAdjudicationResultActionCode (R1 as CWE)

Definition:

Description: Actions to be carried out by the recipient of the Adjudication Result information.

1 ActCareProvisionCode
 ActCareProvisionCode (C1 as CWE)

Definition:

Description:The type and scope of responsibility taken-on by the performer of the Act for a specific subject of care.

Property:   ConceptualSpaceForClassCode: ActClass.PCPR

2 . . ActCareProvisionRequestType

Definition:

Description:Concepts identifying different types of referral requests. These concepts identify the general type of care or category of services requested. They are not used to represent the indication or diagnosis which triggered the need for the referral. E.g. Anger management service, Intensive Care service, Orthodontics service.

2 . . ActCredentialedCareCode
. .   ActCredentialedCareCode (C1 as CWE)

Definition:

Description:The type and scope of legal and/or professional responsibility taken-on by the performer of the Act for a specific subject of care as described by a credentialing agency, i.e. government or non-government agency. Failure in executing this Act may result in loss of credential to the person or organization who participates as performer of the Act. Excludes employment agreements.

Example:Hospital license; physician license; clinic accreditation.

3 . . . ActCredentialedCareProvisionPersonCode
. . .   ActCredentialedCareProvisionPersonCode (C1 as CWE)

Definition:

Description:The type and scope of legal and/or professional responsibility taken-on by the performer of the Act for a specific subject of care as described by an agency for credentialing individuals.

3 . . . ActCredentialedCareProvisionProgramCode
. . .   ActCredentialedCareProvisionProgramCode (C1 as CWE)

Definition:

Description:The type and scope of legal and/or professional responsibility taken-on by the performer of the Act for a specific subject of care as described by an agency for credentialing programs within organizations.

2 . . ActEncounterType

Definition:

Definition:Concepts representing types of patient encounter such as ambulatory encounter, inpatient encounter or emergency encounter.

3 . . . ActEncounterAmbulatoryType
. . .   ActAmbulatoryEncounterCode (R1 as CWE)

Definition:

Definition:A comprehensive term for health care provided in a healthcare facility (e.g. a practitioneraTMs office, clinic setting, or hospital) on a nonresident basis. The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter.

3 . . . ActEncounterEmergencyType
. . .   ActEmergencyEncounterCode (R1 as CWE)

Definition:

Definition:A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility.)

3 . . . ActEncounterFieldType
. . .   ActFieldEncounterCode (R1 as CWE)

Definition:

Definition:A patient encounter that takes place both outside a dedicated service delivery location and outside a patient's residence. Example locations might include an accident site and at a supermarket.

3 . . . ActEncounterHomeHealthType
. . .   ActHomeHealthEncounterCode (R1 as CWE)

Definition:

Definition:Healthcare encounter that takes place in the residence of the patient or a designee

3 . . . ActEncounterInpatientType
. . .   ActInpatientEncounterCode (R1 as CWE)

Definition:

Definition:A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service.

3 . . . ActEncounterShortStayType
. . .   ActShortStayEncounterCode (R1 as CWE)

Definition:

Definition:An encounter where the patient is admitted to a health care facility for a predetermined length of time, usually less than 24 hours.

3 . . . ActEncounterVirtualType
. . .   ActVirtualEncounterCode (R1 as CWE)

Definition:

Definition:A patient encounter where the patient and the practitioner(s) are not in the same physical location. Examples include telephone conference, email exchange, robotic surgery, and televideo conference.

3 . . . EncounterAccident

Definition:

OpenIssue:

Property:   ConceptualSpaceForClassCode: ActClass.ENC

1 ActCodeProcessStep
 ActCodeProcessStep (X1 as CWE)

Definition:

Description: Codes for general process steps.

Examples:

  • lab process steps

  • diagnostic imaging process steps

  • etc. (Missing third example)

Property:   ConceptualSpaceForClassCode: ActClass.SPCTRT

2 . . ActLabProcessCodes

Definition:

Codes for general laboratory process steps.

Property:   ConceptualSpaceForClassCode: ActClass.ACT

3 . . . ActInfoPersistCode

Definition:

The act of storing information to long term storage.

Property:   ConceptualSpaceForClassCode: ActClass.STORE

3 . . . ActObservationVerificationCode

Definition:

The act of verifying an observations. The subject act related to the observation verification (act relationship SUBJ) must be an observation (OBS)

Property:   ConceptualSpaceForClassCode: ActClass.OBS

3 . . . ActSpecimenAccessionCode

Definition:

The accession act related to a specimen or group of specimens.

Property:   ConceptualSpaceForClassCode: ActClass.ACSN

3 . . . ActSpecimenLabelCode

Definition:

The act of printing a specimen label. The printing of a label for a specimen container is a significant act in the workflow for collecting specimens.

Property:   ConceptualSpaceForClassCode: ActClass.PROC

3 . . . ActSpecimenManifestCode

Definition:

The act of adding a specimen to a transportation manifest. For example a laboratory will pack together in a carton all the specimens to be shipped to a reference lab. An electronic manifest showing all the specimens in the shippment is communicated to the reference lab.

Property:   ConceptualSpaceForClassCode: ActClass.TRNS

3 . . . ActSpecimenTransportCode

Definition:

Transportation of a specimen.

Property:   ConceptualSpaceForClassCode: ActClass.TRNS

3 . . . LabResultReportingProcessStepCode
. . .   LabResultReportingProcessStepCode (X1 as CWE)

Definition:

Definition:Used to identify if a lab result is reported as preliminary, final, or corrected. Provides a consistent way to distinguish the business or reporting status of the lab result.

1 ActCognitiveProfessionalServiceCode

Definition:

Denotes the specific service that has been performed. This is obtained from the professional service catalog pertaining to the discipline of the health service provider. Professional services are generally cognitive in nature and exclude surgical procedures. E.g. Provided training, Provided drug therapy review, Gave smoking-cessation counseling, etc.

Property:   ConceptualSpaceForClassCode: ActClass.ACT

1 ActConsentType

Definition:

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.

Property:   ConceptualSpaceForClassCode: ActClass.CONS

2 . . ActDataConsentType

Definition:

Description:The type of data consent directive.

2 . . ActFinancialParticipationConsentType

Definition:

Description:The type of financial participation consent directive.

Examples: The Advanced Beneficiary Notice that Medicare patients consent or dissent to prior to receiving health services in the U.S. \ Current values include consent to financial responsibility (1) if the service is not deemed medically necessary; (2) will self pay for a service; or (3) requests that payer be billed.

2 . . ActInformationAccessCode
. .   ActInformationAccessCode (C1 as CWE)

Definition:

Description: The type of health information to which the subject of the information or the subject's delegate consents or dissents.

Examples:

  • allergy information

  • medication information

  • professional services information

2 . . AdvanceBeneficiaryNoticeType

Definition:

Description:

Represents types of consent that patient must sign prior to receipt of service, which is required for billing purposes.

Examples:

  • Advanced beneficiary medically necessity notice.

  • Advanced beneficiary agreement to pay notice.

  • Advanced beneficiary requests payer billed.

Property:   ConceptualSpaceForClassCode: ActClass.CONS

1 ActContractType

Definition:

An agreement of obligation between two or more parties that is subject to contractual law and enforcement.

Examples: approvals granted by a regulatory agency; contracts measured in financial terms; insurance coverage contracts.

Property:   ConceptualSpaceForClassCode: ActClass.CNTRCT

2 . . ActFinancialContractType

Definition:

A type of Act representing a contract whose value is measured in monetary terms.

Examples:

  • insurance policy

  • providercontract

  • billing arrangement

Property:   ConceptualSpaceForClassCode: ActClass.FCNTRCT

3 . . . ActCoverageTypeCode
. . .   ActCoverageTypeCode (C1 as CWE)

Definition:

Definition: Set of codes indicating the type of insurance policy or program that pays for the cost of benefits provided to covered parties.

Property:   ConceptualSpaceForClassCode: ActClass.COV

4 . . . . ActCoverageEligibilityConfirmationCode

Definition:

Indication of eligibility coverage for healthcare service(s) and/or product(s).

Property:   ConceptualSpaceForClassCode: ActClass.COV

4 . . . . ActCoverageLimitCode

Definition:

Criteria that are applicable to the authorized coverage.

Property:   ConceptualSpaceForClassCode: ActClass.COV

5 . . . . . ActCoverageQuantityLimitCode
. . . . .   ActCoverageQuantityLimitCode (C1 as CWE)

Definition:

Maximum amount paid or maximum number of services/products covered; or maximum amount or number covered during a specified time period under the policy or program.

5 . . . . . ActCoveredPartyLimitCode

Definition:

Codes representing the types of covered parties that may receive covered benefits under a policy or program.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

6 . . . . . . ActCoveragePartyLimitGroupCode

Definition:

Codes representing the level of coverage provided under the policy or program in terms of the types of entities that may play covered parties based on their personal relationships or employment status.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . ActInsurancePolicyType
. . . .   ActInsurancePolicyCode (R1 as CWE)

Definition:

Description: Types of insurance coverage legal documentation to cover healthcare costs.

Examples:

  • Automobile

  • Extended healthcare

  • Worker's compensation

4 . . . . ActInsuranceTypeCode
. . . .   ActInsuranceTypeCode (C1 as CWE)

Definition:

Definition: Set of codes indicating the type of insurance policy. Insurance, in law and economics, is a form of risk management primarily used to hedge against the risk of potential financial loss. Insurance is defined as the equitable transfer of the risk of a potential loss, from one entity to another, in exchange for a premium and duty of care. A policy holder is an individual or an organization enters into a contract with an underwriter which stipulates that, in exchange for payment of a sum of money (a premium), one or more covered parties (insureds) is guaranteed compensation for losses resulting from certain perils under specified conditions. The underwriter analyzes the risk of loss, makes a decision as to whether the risk is insurable, and prices the premium accordingly. A policy provides benefits that indemnify or cover the cost of a loss incurred by a covered party, and may include coverage for services required to remediate a loss. An insurance policy contains pertinent facts about the policy holder, the insurance coverage, the covered parties, and the insurer. A policy may include exemptions and provisions specifying the extent to which the indemnification clause cannot be enforced for intentional tortious conduct of a covered party, e.g., whether the covered parties are jointly or severably insured.

Discussion: In contrast to programs, an insurance policy has one or more policy holders, who own the policy. The policy holder may be the covered party, a relative of the covered party, a partnership, or a corporation, e.g., an employer. A subscriber of a self-insured health insurance policy is a policy holder. A subscriber of an employer sponsored health insurance policy is holds a certificate of coverage, but is not a policy holder; the policy holder is the employer. See CoveredRoleType.

5 . . . . . ActHealthInsuranceTypeCode
. . . . .   ActHealthInsuranceTypeCode (C1 as CWE)

Definition:

Definition: Set of codes indicating the type of health insurance policy that covers health services provided to covered parties. A health insurance policy is a written contract for insurance between the insurance company and the policyholder, and contains pertinent facts about the policy owner (the policy holder), the health insurance coverage, the insured subscribers and dependents, and the insurer. Health insurance is typically administered in accordance with a plan, which specifies (1) the type of health services and health conditions that will be covered under what circumstances (e.g., exclusion of a pre-existing condition, service must be deemed medically necessary; service must not be experimental; service must provided in accordance with a protocol; drug must be on a formulary; service must be prior authorized; or be a referral from a primary care provider); (2) the type and affiliation of providers (e.g., only allopathic physicians, only in network, only providers employed by an HMO); (3) financial participations required of covered parties (e.g., co-pays, coinsurance, deductibles, out-of-pocket); and (4) the manner in which services will be paid (e.g., under indemnity or fee-for-service health plans, the covered party typically pays out-of-pocket and then file a claim for reimbursement, while health plans that have contractual relationships with providers, i.e., network providers, typically do not allow the providers to bill the covered party for the cost of the service until after filing a claim with the payer and receiving reimbursement).

4 . . . . ActProgramTypeCode
. . . .   ActProgramTypeCode (C1 as CWE)

Definition:

Definition: A set of codes used to indicate coverage under a program. A program is an organized structure for administering and funding coverage of a benefit package for covered parties meeting eligibility criteria, typically related to employment, health, financial, and demographic status. Programs are typically established or permitted by legislation with provisions for ongoing government oversight. Regulations may mandate the structure of the program, the manner in which it is funded and administered, covered benefits, provider types, eligibility criteria and financial participation. A government agency may be charged with implementing the program in accordance to the regulation. Risk of loss under a program in most cases would not meet what an underwriter would consider an insurable risk, i.e., the risk is not random in nature, not financially measurable, and likely requires subsidization with government funds.

Discussion: Programs do not have policy holders or subscribers. Program eligibles are enrolled based on health status, statutory eligibility, financial status, or age. Program eligibles who are covered parties under the program may be referred to as members, beneficiaries, eligibles, or recipients. Programs risk are underwritten by not for profit organizations such as governmental entities, and the beneficiaries typically do not pay for any or some portion of the cost of coverage. See CoveredPartyRoleType.

2 . . ActFinancialTransactionType

Definition:

A type of Act representing any transaction between two accounts whose value is measured in monetary terms.

Examples:

  • patient account transaction

  • encounter accounttransaction

  • cost center transaction

Property:   ConceptualSpaceForClassCode: ActClass.XACT

3 . . . ActBillingArrangementType
. . .   ActBillingArrangementCode (R1 as CWE)

Definition:

Description: Types of provision(s) made for reimbursing for the deliver of healthcare services and/or goods provided by a Provider for one or more occurrence or over a specified period.

Examples:

  • Contract

  • Rostering

  • Capitation

1 ActDataOperationType

Definition:

Description: Types of operations that may be performed on objects. Here, objects are broadly understood as information system-related entities (e.g., devices, files, records, tables, processes, programs, domains) containing or receiving information.

Examples:

  • Create

  • Update

  • Delete

Open Issue: This is too restrictive to deal with what CBCC wants.

Property:   ConceptualSpaceForClassCode: ActClass.CACT

2 . . ActDataAccessOperationType

Definition:

Description: Types of operations that may accomplish access of information. Here, objects are broadly understood as information system-related entities (e.g., devices, files, records, tables, processes, programs, domains) containing or receiving information.

Examples:

  • Query

  • Search

  • Transport

  • Send

  • Receive

Property:   ConceptualSpaceForClassCode: ActClass.CACT

2 . . ActDataCollectionOperationType

Definition:

Description: Types of operations that may accomplish collection or related management of information. Here, objects are broadly understood as information system-related entities (e.g., devices, files, records, tables, processes, programs, domains) containing or receiving information.

Examples:

  • Create

  • Store

  • Archive

Property:   ConceptualSpaceForClassCode: ActClass.CACT

2 . . ActDataDisclosureOperationType

Definition:

Description: Types of operations that may accomplish disclosure of information. Here, objects are broadly understood as information system-related entities (e.g., devices, files, records, tables, processes, programs, domains) containing or receiving information.

Examples:

  • Disclose

  • Forward

  • Publish

Property:   ConceptualSpaceForClassCode: ActClass.CACT

2 . . ActDataUseOperationType

Definition:

Description: Types of operations that may accomplish usage of information. Here, objects are broadly understood as information system-related entities (e.g., devices, files, records, tables, processes, programs, domains) containing or receiving information.

Examples:

  • Activate

  • Release

  • Execute Read

  • Display

  • Update

  • Append

  • Amend

Property:   ConceptualSpaceForClassCode: ActClass.CACT

1 ActDetectedIssueManagementType
 ActDetectedIssueManagementCode (R1 as CWE)

Definition:

Description: Issue management types that dealing with detected issue observations.

Rationale: Allows for consistent specification and interpretation of issue management.

1 ActDisciplinaryActionCode

Definition:

Includes coded types of actions that can be taken by a supervising entity in response to inappropriate action (or inaction) on the part of a supervised entity.

Property:   ConceptualSpaceForClassCode: ActClass.DISPACT

1 ActEventCategoryWorkingListType

Definition:

Description: List of broad catagorizations of clinical event records.

Examples:

  • Allergies
  • Drugs
  • Referrals

Property:   ConceptualSpaceForClassCode: ActClass.LIST

2 . . ActCommonCodedClinicalObservationCategoryListType

Definition:

Description:Lists of high-level categorizations for clinical coded observations that do not require numeric values with a specific unit of measure.

Examples:

  • Symptoms
  • History
  • Observations

Property:   ConceptualSpaceForClassCode: ActClass.LIST

2 . . ActSimpleMeasurableClinicalObservationCategoryListType

Definition:

Description: of high-level categorization for clinical non-laboratory and non-diagnostic image measured observations with numeric values and specific units of measure.

Examples:

  • Vital Signs
  • Physiological Measurements
  • Procedure Results

Property:   ConceptualSpaceForClassCode: ActClass.LIST

1 ActEventCriteriaType

Definition:

Description: Describes types of criteria used when making observations, conducting procedures, and substance administrations.

Examples:

  • medications

  • immunizations

Property:   ConceptualSpaceForClassCode: ActClass.ACT

2 . . ActProcedureEventCriteriaType

Definition:

Description: of procedure used for evaluating a precondition, goal, or trigger.

Examples:

  • some radiology procedures

  • respiratory therapy

  • physical therapy

Property:   ConceptualSpaceForClassCode: ActMood.EVN.CRT

2 . . ActSubstanceAdministrationEventCriteriaType

Definition:

Description: Type of substance administration used for evaluating a precondition, goal, or trigger.

Examples:

  • other substance administrations

  • respiratory therapy

  • immunizations

Property:   ConceptualSpaceForClassCode: ActMood.EVN.CRT

2 . . ObservationEventCriteriaType

Definition:

Description: of observation used for evaluating a precondition, goal, or trigger.

Examples:

  • age-based criteria

  • diagnostic-based criteria

  • simple observation-based criteria (vital signs)

Property:   ConceptualSpaceForClassCode: ActMood.EVN.CRT

3 . . . ObservationEventLabCriteriaType

Definition:

Description: Type of observation used in lab for evaluating reference ranges.

Examples:

  • age-based criteria

  • sex-based criteria

  • condition-based criteria

Property:   ConceptualSpaceForClassCode: ActMood.EVN.CRT

1 ActExposureCode
 ActExposureCode (X1 as CWE)

Definition:

Concepts that identify the type or nature of exposure interaction. Examples include "household", "care giver", "intimate partner", "common space", "common substance", etc. to further describe the nature of interaction.

Property:   ConceptualSpaceForClassCode: ActClass.EXPOS

1 ActFinancialDetectedIssueManagementCode

Definition:

Codes dealing with the management of Detected Issue observations for the financial acts domain.

Property:   ConceptualSpaceForClassCode: ActClass.ACT

1 ActIncidentCode

Definition:

Definition: Set of codes indicating the type of incident or accident.

Property:   ConceptualSpaceForClassCode: ActClass.INC

2 . . ActPatientSafetyIncidentCode

Definition:

Definition: A code specifying the particular kind of Patient Safety Incident that the Incident class instance represents.

Examples:"Medication incident", "slips, trips and falls incident".The actual value set for the domain will be determined by each (realm) implementation, whose Patient Safety terminology will be specific, although probably linked to the WHO Patient Safety Taxonomy that is currently under development

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

1 ActInformationTransferCode
 ActInformationTransferCode (R1 as CWE)

Definition:

Description: Conveyance of the type of information transfer protocol.

Property:   ConceptualSpaceForClassCode: ActClass.TRFR

1 ActInvoiceElementCode
 ActInvoiceElementCode (C1 as CWE)

Definition:

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.

Property:   ConceptualSpaceForClassCode: ActClass.INVE

2 . . ActInvoiceDetailCode
. .   ActInvoiceDetailCode (C1 as CWE)

Definition:

Codes representing a service or product that is being invoiced (billed). The code can represent such concepts as "office visit", "drug X", "wheelchair" and other billable items such as taxes, service charges and discounts.

3 . . . ActInvoiceDetailClinicalProductCode

Definition:

OpenIssue:

3 . . . ActInvoiceDetailClinicalServiceCode

Definition:

An identifying data string for healthcare procedures.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . CPT4

Definition:

Description:Physicians Current Procedural Terminology (CPT) Manual is a listing of descriptive terms and identifying codes for reporting medical services and procedures performed by physicians. Available for the AMA at the address listed for CPT above. These codes are found in Appendix A of CPT 2000 Standard Edition. (CPT 2000 Standard Edition, American Medical Association, Chicago, IL).

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . CPT5

Definition:

Description:Physicians Current Procedural Terminology (CPT) Manual is a listing of descriptive terms and identifying codes for reporting medical services and procedures performed by physicians. Available for the AMA at the address listed for CPT above. These codes are found in Appendix A of CPT 2000 Standard Edition. (CPT 2000 Standard Edition, American Medical Association, Chicago, IL).

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . HCPCS

Definition:

Description:Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes are procedure identifying codes. HCPCS is Health Care Finance AdministrationaTMs (HFCA) coding scheme to group procedures performed for payment to providers. contains codes for medical equipment, injectable drugs, transportation services, and other services not found in CPT4.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . ICD10PCS

Definition:

Description:International Classification of Diseases, 10th Revision, Procedure Coding System (ICD-10-PCS) are procedure identifying codes. ICD-10-PCS describes the classification of inpatient procedures for statistical purposes.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . ICD9PCS

Definition:

Description:International Classification of Diseases, 9th Revision, Procedure Coding System (ICD-9-PCS) are procedure identifying codes. ICD-9-PCS describes the classification of inpatient procedures for statistical purposes.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . ActInvoiceDetailTaxType
. . .   ActInvoiceDetailTaxCode (R1 as CWE)

Definition:

Description: Types of tax associated with billable services or products.

Examples:

  • Provincial or State sales tax

  • Harmonized sales tax

  • Federal sales tax

3 . . . HCPCSAccommodationCode

Definition:

Description:External value set for accommodation types used in the U.S. Health Care Financing Administration (HCFA) Common Procedure Coding System (HCPCS) including modifiers.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ActInvoiceElementSummaryType
. .   ActInvoiceElementSummaryCode (R1 as CWE)

Definition:

Description: Types of summary information that can be reported by queries dealing with Statement of Financial Activity (SOFA). The summary information is generally used to help resolve balance discrepancies between providers and payors.

Examples:

  • number and total value of payable items;

  • number and value of same period nullify items;

  • number and value of prior nullify;

  • number of non-payable nullify items;

  • number of pending items;

  • number of rejected items;

  • number of adjudicated to zero items;

  • reimbursement items (e.g., pay patient)

  • Adjudicated non-payee payable prior-period electronic amount

  • Adjudicated nullified prior-period electronic amount

  • Adjudicated refused prior-period electronic amount

3 . . . ActInvoiceAdjudicationPaymentSummaryType
. . .   ActInvoiceAdjudicationPaymentSummaryCode (R1 as CWE)

Definition:

Description: Types of grouping of invoice elements (totals, sub-totals), reported through a Payment Advice or a Statement of Financial Activity (SOFA). The code can represent summaries by day, location, payee and other cost elements such as bonus, retroactive adjustment and transaction fees.

2 . . ActInvoiceGroupType
. .   ActInvoiceGroupCode (R1 as CWE)

Definition:

Description: Types 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 its immediate children invoice elements.

Examples:

  • CPINV - Clinical product invoice

  • CSINV- Clinical service invoice

  • RXDINV - Drug invoice

  • RXCINV - Compound invoice

  • CSPINV - Combined service and clinical product invoice

2 . . ActInvoiceOverrideType
. .   ActInvoiceOverrideCode (R1 as CWE)

Definition:

Description: Types of responses that will occur as a result of the adjudication of an electronic invoice at a summary level and provides guidance on interpretation of the referenced adjudication results.

Examples:

  • Re-bill for the professional fee

  • Good faith override

  • Wasted Drug

1 ActListCode
 ActListCode (C1 as CWE)

Definition:

Provides codes associated with ActClass value of LIST (working list)

Property:   ConceptualSpaceForClassCode: ActClass.LIST

2 . . ActProcedureCategoryList

Definition:

Description:Describes the high level classification of professional services for grouping.

Examples:Education, Counseling, Surgery, etc.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ActTherapyDurationWorkingListCode
. .   ActTherapyDurationWorkingListCode (C1 as CWE)

Definition:

Codes used to identify different types of 'duration-based' working lists. Examples include "Continuous/Chronic", "Short-Term" and "As-Needed".

3 . . . ActMedicationTherapyDurationWorkingListCode
. . .   ActMedicationTherapyDurationWorkingListCode (C1 as CWE)

Definition:

Definition:A collection of concepts that identifies different types of 'duration-based' mediation working lists.

Examples:"Continuous/Chronic" "Short-Term" and "As Needed"

1 ActMonitoringProtocolType
 ActMonitoringProtocolCode (R1 as CWE)

Definition:

Description: Identifies types of monitoring programs such as tracking specified medication prescribing e.g. narcotic(s), identifying investigational studies or identifying programs regarding reimbursement or prescribing privileges.

1 ActNonObservationIndicationCode
 ActNonObservationIndicationCode (C1 as CWE)

Definition:

Description:Concepts representing indications (reasons for clinical action) other than diagnosis and symptoms.

Property:   ConceptualSpaceForClassCode: ActClass.ACT

1 ActOrderCode

Definition:

The type of order that was fulfilled by the clinical service

Property:   ConceptualSpaceForClassCode: ActClass.ACT

1 ActPolicyType
 ActPolicyType (R1 as CWE)

Definition:

Description:Types of policies that further specify the ActClassPolicy value set.

Property:   ConceptualSpaceForClassCode: ActClass.POLICY

2 . . ActPrivacyPolicyType
. .   ActPrivacyPolicy (R1 as CWE)

Definition:

Description:Types of privacy policies that further specify the ActClassPolicy value set e.g. override policy, minor's rights to mask sensitive information policy, opt-in, opt-out policy.

3 . . . ActConsentDirectiveType
. . .   ActConsentDirective (R1 as CWE)

Definition:

Description:Specifies the type of consent directive indicated by an ActClassPolicy e.g., a 3rd party authorization to disclose or consent for a substitute decision maker (SDM) or a notice of privacy policy. Sibling to ActPrivacyPolicyType and Child of ActPolicyType.

3 . . . ActPrivacyLawPrivacyPolicyType
. . .   ActUSPrivacyLaw (X1 as CWE)

Definition:

Description: Types of jurisdictional mandates relating to privacy.

3 . . . ActSensitivityPrivacyPolicyType
. . .   InformationSensitivityPolicy (R1 as CWE)

Definition:

A sensitivity policy is adopted by an enterprise or group of enterprises (a "policy domain") through a formal data use agreement that stipulates the value, importance, and vulnerability of information. A sensitivity code representing a sensitivity policy may be associated with criteria such as categories of information or sets of information identifiers (e.g., a value set of clinical codes or branch in a code system hierarchy). These criteria may in turn be used for the Policy Decision Point in a Security Engine. A sensitivity code may be used to set the confidentiality code used on information about Acts and Roles to trigger the security mechanisms required to control how security principals (i.e., a person, a machine, a software application) may act on the information (e.g., collection, access, use, or disclosure). Sensitivity codes are never assigned to the transport or business envelope containing patient specific information being exchanged outside of a policy domain as this would disclose the information intended to be protected by the policy. When sensitive information is exchanged with others outside of a policy domain, the confidentiality code on the transport or business envelope conveys the receiver's responsibilities and indicates the how the information is to be safeguarded without unauthorized disclosure of the sensitive information. This ensures that sensitive information is treated by receivers as the sender intends, accomplishing interoperability without point to point negotiations.

4 . . . . ActEntityInformationSensitivityPrivacyPolicyType

Definition:

Description: Types of Sensitivity policies that may apply to a sensitive attribute on an Entity.

4 . . . . ActInformationSensitivityPrivacyPolicyType

Definition:

Description: Types of sensitivity policies that apply to Acts.

4 . . . . ActRoleInformationSensitivityPrivacyPolicyType
. . . .   RoleInformationSensitivityPolicy (R1 as CWE)

Definition:

Description: Types of sensitivity policies that apply to Roles.

2 . . ActSecurityPolicyType
. .   SecurityPolicy (R1 as CWE)

Definition:

Types of security policies that further specify the ActClassPolicy value set.

3 . . . ActObligationSecurityPolicyType
. . .   ObligationPolicy (R1 as CWE)

Definition:

Conveys the mandated workflow action that an information custodian, receiver, or user must perform.

Usage Note: Per ISO 22600-2, ObligationPolicy instances "are event-triggered and define actions to be performed by manager agent". Per HL7 Composite Security and Privacy Domain Analysis Model: This value set refers to the action required to receive the permission specified in the privacy rule. 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.

3 . . . ActRefrainSecurityPolicyType
. . .   RefrainPolicy (R1 as CWE)

Definition:

Conveys prohibited actions which an information custodian, receiver, or user is not permitted to perform unless otherwise authorized or permitted under specified circumstances.

Usage Notes: ISO 22600-2 species that a Refrain Policy "defines actions the subjects must refrain from performing". Per HL7 Composite Security and Privacy Domain Analysis Model: May be used to indicate that a specific action is prohibited based on specific access control attributes e.g., purpose of use, information type, user role, etc.

1 ActProcedureCode

Definition:

Description: An identifying code for healthcare interventions/procedures.

Examples:
  • immunization
  • appendectomy
  • physiotherapy

Property:   ConceptualSpaceForClassCode: ActClass.PROC

2 . . ActBillableServiceCode

Definition:

Definition: An identifying code for billable services, as opposed to codes for similar services used to identify them for functional purposes.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . ActBillableTreatmentPlanCode

Definition:

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . ActMedicalBillableServiceCode

Definition:

Definition: An identifying code for billable medical services, as opposed to codes for similar services to identify them for clinical purposes.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . ActNonMedicalBillableServiceCode

Definition:

Definition: An identifying code for billable services that are not medical procedures, such as social services or governmental program services.

Example: Building a wheelchair ramp, help with groceries, giving someone a ride, etc.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ActMolecularInteractionType

Definition:

Chemical reactions in the widest sense of the word.

Examples: Transcription (creating mRNA from a DNA gene), translation (creating a protein from mRNA), cleavage (hydrolysis of a peptide), substitution (replacing an element or residue with another, such as in glycosylation, phosphorylation), addition (adding a residue to a double bond), receptor binding.

2 . . ActOralHealthProcedureCode

Definition:

Description:An identifying code for oral health interventions/procedures.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ActOrderableProcedureCode

Definition:

Description: Concept domain which includes those ActProcedureCodes which are appropriate for ordering.

Examples:

  • physical therapies

  • excisions

  • surgery

Property:   ConceptualSpaceForClassCode: ActClass.PROC

2 . . ActProductReconstitutionType

Definition:

DESCRIPTION

Examples:

  • Dilution
  • Dissolution
  • Suspension
2 . . ActProfessionalServiceCode

Definition:

Description: Denotes the specific professional service that has been performed. This is obtained from the professional service catalog pertaining to the discipline of the health service provider.

Examples:

  • adjustment of hearing aid

  • excision of skin lesion

  • stitching skin lacerations

2 . . ActSpecimenCollectionProcedureType

Definition:

Description: Used to further classify the type of specimen collection procedure being documented.

Examples:

  • Venipuncture

  • Swab

  • Biopsy

Property:   ConceptualSpaceForClassCode: ActClass.SPECCOLLECT

2 . . ActSubstanceAdministrationCode
. .   ActSubstanceAdministrationCode (C1 as CWE)

Definition:

Description: Describes the type of substance administration being performed. This should not be used to carry codes for identification of products. Use an associated role or entity to carry such information.

Property:   ConceptualSpaceForClassCode: ActClass.SBADM

3 . . . ActSubstanceAdministrationImmunizationCode
. . .   ActSubstanceAdministrationImmunizationCode (C1 as CWE)

Definition:

The introduction of ??? with the intent of stimulating an immune response, aimed at preventing subsequent infections by more viable agents.

2 . . ActSubstanceDerivationType

Definition:

Acts of producing a substance by processing input material in any way thus deriving the product substance from the inputs

Examples: Fermentation, filtration, separation, extraction, or any complex procedure involving multiple such steps.

UsageNotes: This domain may involve molecular interactions as components, but substance derivation - even if implementing a single defined reaction on the molecular level - implies not only that reaction but the methods and devices by which to induce that reaction.

2 . . ActSubstanceExtractionCode

Definition:

Description: In addition to the class code, further defines the type of substance extraction.

Examples:

  • excision

  • surgical

  • passive

3 . . . ActBloodDonationType

Definition:

Description: Defines the type of blood donation.

Examples:

  • autologous

  • directed

  • volunteer

2 . . NutritionModificationType

Definition:

Concepts that are used to convey modifications to the food that should be given in a diet order. These can be derived from patient allergies, intolerances, or preferences. They can also be specific to the order and not have any relationship to the allergies, intolerances, or preferences.

Examples:

  • Vegetarian
  • Liquids separate from solids
  • Small Portions
3 . . . DietTextureModificationType

Definition:

A set of concepts that identifies any texture modifications that should be made to a diet order.

Examples:

  • Pudding Thick
  • Pureed
  • Easy to Chew
1 ActProductApprovalType

Definition:

Description: An approval granted to a product by a regulatory agency or other government body.

Examples:

  • Approval to sell

  • Approval to initiate clinical trial

  • Approval to market (i.e., advertise)

Property:   ConceptualSpaceForClassCode: ActClass.CNTRCT

2 . . ActProductApprovalApplicationType

Definition:

Description: A type of application made in order to obtain a product approval from a regulatory agency or other government body.

Examples:

  • Application for new approval
  • Application for renewal of approval
  • Application for variation of approval
2 . . ActProductApprovalProcessType

Definition:

Description: A type of approval process by which a product approval is obtained from a regulatory agency or other government body.

Examples:

  • Centralized process approval
  • Mutual recognition process approval
  • National process approval
1 ActRPSRegulatoryPolicy

Definition:

Identifies different classes of regulatory policy that can be applied within a Regulated Product Submission.

Usage Note: This Domain is used to administratively group its subdomains specifically for usage in the RPS model, and is not intended to participate in any binidngs.

2 . . ActRPSProductCategoryType

Definition:

Identifies the legal or administrative category assigned to a regulated product that determines or influences the way in which its submission is reviewed.

Examples:

  • New active ingredients
  • New ethical combination drug
  • New administrative route

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

2 . . ActRPSReviewTimeType

Definition:

Identifies the time period in which a submission of a given type is to be reviewed as established by law or practice in the particular regulatory realm.

Examples:

  • 30 days, reduced time
  • 60 days, regular time
  • 90 days, extended time

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

2 . . ActRegulatoryStatusType

Definition:

Identifies a temporary or final legal status assigned to a submission by a particular regulatory realm based on the laws and practices of the realm.

Examples:

  • Active (as authorized by section abc)
  • Approved (under section xyz)
  • Withdrawn (under section pqr)

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

1 ActReactionActionTakenType

Definition:

Description: A type of act that indicates the action taken by a practitioner or other responsible party in response to the reaction/event that is reported in the ICSR.

Examples:

  • failing device replaced

  • medication stopped

  • medication dose adjusted

Property:   ConceptualSpaceForClassCode: ActClass.ACT

1 ActRecordOrganizerType

Definition:

Description: A code further classifying the type of record organizer. Used with the ActClassRecordOrganizer ActClass concept domain.

Examples:

  • CDA R2

  • Electrolytes Battery

  • Specimen Cluster

Property:   ConceptualSpaceForClassCode: ActClass._ActClassRecordOrganizer

2 . . ActCompositionType

Definition:

A context representing a grouped commitment of information to the EHR. It is considered the unit of modification of the record, the unit of transmission in record extracts, and the unit of attestation by authorizing clinicians.

Examples: document; authentication unit; transmission unit.

Property:   ConceptualSpaceForClassCode: ActClass.COMPOSITION

3 . . . ActContextOfUseType

Definition:

Identifies the heading under which a document is to appear in a pre-defined, pro forma table of contents for a collection of documents within a regulatory category.

Examples:

  • m1-1-forms (eCTD module 1, forms)
  • m1-1-1-fda-form-1571 (eCTD. Module 1, specific FDA form)
  • m3-2-s-drug-substance (eCTD module 3, section 2, drug substance by substance)

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

3 . . . ActKeywordsType

Definition:

Codes for additional metadata to be assigned to document or context of use instances to organize a group of documents within the same table of contents heading. These external code systems specify the category or type of keyword (e.g. Species) and the applicable values.

Examples:

  • Species code system
  • Species code
  • Sponsor's manufacturing site code system

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

3 . . . ActRegulatoryCategoryType

Definition:

Identifies the regulatory processes and/or submission contents specified in law or practice for a particular realm used to organize submitted materials.

Examples:

  • Application Type: NDA
  • Submission Type: Efficacy Supplement
  • Submission Unit Type: Amendment

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

3 . . . DocumentType
. . . [2.16.840.1.113883.1.11.10870]

Definition:

The kind of document. Possible values: discharge summary, progress note, Oncology note, etc.

Property:   ConceptualSpaceForClassCode: ActClass.DOC

4 . . . . ActFinancialSupportingAttachmentCode

Definition:

Description:Identifies the type of document that was attached to support the processing of claims, adjudication decision determination or extensions to coverage.

Property:   ConceptualSpaceForClassCode: ActClass.DOC

5 . . . . . ActClaimAttachmentCode
. . . . .   ActClaimAttachmentCategoryCode (R1 as CWE)

Definition:

Description:Contrains the type of attachment (document, XRAY, bit map image, etc.) included to support a healthcare claim. Vocabulary bound to this domain should be a specification for the type of document (i.e. WCB First Report of Acccident - Form 8).

5 . . . . . ActSpecialAuthorizationAttachmentCode

Definition:

Description:Identifies the type of document that is used to support a request which requires special authorization. Example values in this concept domain could be: coverage extensions, step therapy, medical report, lab result, etc.

4 . . . . ActICSRDocumentType

Definition:

Description: A type of document that has information related to the investigation of an adverse event or product problem report.

Examples:

  • Autopsy report

  • toxicology report

  • clinical journal article

Property:   ConceptualSpaceForClassCode: ActClass.DOC

4 . . . . ActIdentityDocumentCode

Definition:

Code identifying the type of identification document (e.g. passport, drivers license)

Implementation Note:The proposal called for a domain, but a code was also provided. When codes are available for the value set the code IDENTDOC (identity document) will be used as the headcode for the specializable value set.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . ActInformRequestType

Definition:

Description: Information type for which a provider is requesting routing of health information. This could include messaging of results or documents especially in the context of a specific service delivery location.

Examples:

  • Diagnostic Image Interpretations

  • Lab Test Results

  • Electrocardiogram Reports

Property:   ConceptualSpaceForClassCode: ActClass.DOC

4 . . . . ActInformationCategoryCode
. . . .   ActInformationCategoryCode (C1 as CWE)

Definition:

Definition:Indicates the set of information types which may be manipulated or referenced, such as for recommending access restrictions.

Property:   ConceptualSpaceForClassCode: ActClass.DOC

4 . . . . ActMedicationDocumentCode

Definition:

Indicates the types of documents that can be associated with a medication or group of medications.

Examples include: Patient monographs, Provider monographs, Drug protocols, etc.

4 . . . . ActProductDocumentationType

Definition:

Description:

A type of documentation that is used to convey information about a product or an aspect of its life as a product - ranging from production to disposition.

Examples:

  • Bill of lading

  • product label

  • Report of Product Disposal

Property:   ConceptualSpaceForClassCode: ActClass.DOC

4 . . . . ActQualityMeasureDocumentType
. . . .   HealthQualityMeasureDocument (R1 as CWE)

Definition:

A type of document used to represent a health quality measure (aka eMeasure).

4 . . . . ActRPSDocumentType

Definition:

Identifies the document type from a regulator-defined set of codes similar to the ICH-defined File Tags used on clinical study documents in an eCTD.

Examples:

  • Pre-clinical study report
  • Study report
  • Sample CRF

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

4 . . . . ActSpecialAuthorizationCode

Definition:

Description:Constrains vocabulary to that which describes the type of documents that can be attached to a financial transaction such as a Special Authorization Request.

Example values under this concept domain could be: drug, device, service, etc.

Property:   ConceptualSpaceForClassCode: ActClass.DOC

2 . . ActGrouperType

Definition:

Description: Further defines the type of grouping of orders or events. This concept domain is intended to be used with the GROUPER Act class code.

Examples:

  • requisition

  • pre-coordinated order set

  • custom order set

Property:   ConceptualSpaceForClassCode: ActClass.GROUPER

2 . . ActICSRRecordOrganizerType

Definition:

Description: A type of concept that is used within adverse event and product problem reporting to organize data - often clinical in nature - provided for an investigative subject or other party within the scope of the investigation.

Examples:

  • Medical history

  • previous drug reactions

  • immunization history

Property:   ConceptualSpaceForClassCode: ActClass.CATEGORY

2 . . ActRecordContainerType

Definition:

Description: Container of clinical statements. Navigational. No semantic content. Knowledge of the section code is not required to interpret contained observations. Represents a heading in a heading structure, or "container tree".

Examples: category; document section; document body.

Property:   ConceptualSpaceForClassCode: ActClass.CONTAINER

3 . . . DocumentSectionType

Definition:

A type of document section (specialization of ActClass "DOCSECT").

Property:   ConceptualSpaceForClassCode: ActClass.DOCSECT

4 . . . . ActQualityMeasureSectionType
. . . .   QualityMeasureSectionType (R1 as CWE)

Definition:

A type of document section within a health quality measure (aka eMeasure), used to cluster the various parts of the eMeasure into a more human navigable format.

1 ActRegistryCode

Definition:

This is the domain of registry types. Examples include Master Patient Registry, Staff Registry, Employee Registry, Tumor Registry.

Property:   ConceptualSpaceForClassCode: ActClass.REG

1 ActServiceDeliveryLocationServiceType

Definition:

Description:Concepts representing the categorization of health services available at a particular delivery location site.

Examples:

  • anesthetic service
  • colonoscopy service
  • orthopedic service
1 ActSubstanceAdminSubstitutionCode
 ActSubstanceAdminSubstitutionCode (R1 as CWE)

Definition:

Definition:Identifies the types of substitution that may be permitted when ordering a medication, as well as those which have actually occurred during the act of dispensing.

Property:   ConceptualSpaceForClassCode: ActClass.SUBST

1 ActSupplyType

Definition:

Description: Further defines the type of supply for order or distribution.

Examples:

  • central supply

  • materials management

  • nurse station supply

Property:   ConceptualSpaceForClassCode: ActClass.SPLY

2 . . ActPharmacySupplyType
. .   ActPharmacySupplyType (R1 as CWE)

Definition:

Definition:Identifies types of dispensing events.

2 . . ActProductAcquisitionType
. .   ActProductAcquisitionCode (R1 as CWE)

Definition:

Description: Financial Acquisition Terms: categorizations of acquisition terms for a product.

Types of method a product can be obtained for use by the subject of the supply act (e.g. patient). Product examples are consumable or durable goods.

Examples:

  • Loan

  • Rent

  • Sale

Property:   ConceptualSpaceForClassCode: ActClass.SPLY

2 . . ActProductLifeCycleEventType

Definition:

Description: A type of activity that takes place during the life of a product as it moves from the point of production to the point of consumption, use, or disposition (most notably in the case of contaminated products). It will be possible for concepts at different levels of granularity to be included.

Examples:

  • Manufacture

  • paint

  • wholesale

  • dispose

Property:   ConceptualSpaceForClassCode: ActClass.ACT

2 . . OralDietSupplyType

Definition:

Concepts representing diets that can be taken via the mouth.

Examples:

  • General
  • Pureed
  • Easy to Chew
1 ActTaskCode
 ActTaskCode (C1 as CWE)

Definition:

Description: A task or action that a user may perform in a clinical information system

Examples:

  • medication order entry
  • laboratory test results review
  • problem list entry

Property:   ConceptualSpaceForClassCode: ActClass.ACT

1 ActTransportationModeCode
 ActTransportationModeCode (C1 as CWE)

Definition:

Characterizes how a transportation act was or will be carried out.

Examples: Via private transport, via public transit, via courier.

Property:   ConceptualSpaceForClassCode: ActClass.TRNS

2 . . ActPatientTransportationModeCode
. .   ActPatientTransportationModeCode (C1 as CWE)

Definition:

Definition: Characterizes how a patient was or will be transported to the site of a patient encounter.

Examples: Via ambulance, via public transit, on foot.

1 AdverseEventProductRelatedInvestigationType

Definition:

Description: Different types that are used to organize and classify product related investigations.

Examples:

  • Original source investigation
  • Secondary party investigation
  • Report to regulatory authority
1 DEADrugSchedule

Definition:

DEA schedule for a drug.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

1 HL7AccommodationCode

Definition:

Description:Accommodation type. In Intent mood, represents the accommodation type requested. In Event mood, represents accommodation assigned/used. In Definition mood, represents the available accommodation type.

Property:   ConceptualSpaceForClassCode: ActClass.ACCM

1 HL7TriggerEventCode
 TriggerEventID (R1 as CWE)

Definition:

The trigger event referenced by the Control Act instance. Values are drawn from the available trigger events used in the release of HL7 identified by the versionCode.

Property:   ConceptualSpaceForClassCode: ActClass.CACT

2 . . LaboratoryTriggerEventType
. .   LabResultTriggerEvents (R1 as CWE)

Definition:

Description: Trigger events associated with laboratory results.

Examples:

  • Lab result activate

  • Lab result complete

  • Lab result abort

Property:   ConceptualSpaceForClassCode: ActClass.CACT

2 . . SpecimenProcessTriggerEventType

Definition:

Description: Trigger events associated with specimen process steps.

Examples:

  • Specimen process step activate

  • Specimen process step complete

  • Specimen process step abort

Property:   ConceptualSpaceForClassCode: ActClass.CACT

1 ImmunizationForecastStatus
 immunizationForecastStatusObservationValue (R1 as CWE)

Definition:

1 ManufacturerActivityActType

Definition:

Description: The activity of businesses operating in the manufacture and distribution of products.

Examples:

  • manufacture

  • repack

  • import

Property:   ConceptualSpaceForClassCode: ActClass.ACT

2 . . MarketingActivityActType

Definition:

Description: The broad activity of businesses operating in the distribution of products, the general act of making a product available to the public.

Examples:

  • Marketing, (this is required as a singleton value set, as there may be no other use case for this than to distinguish one Act of handling products from other Acts, such as manufacturing.)

Property:   ConceptualSpaceForClassCode: ActClass.ACT

1 ObservationType
 ObservationType (C1 as CWE)

Definition:

Identifies the kinds of observations that can be performed

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . ActDetectedIssueCode

Definition:

Definition:Identifies what type of issue detected during occurrence of an act (e.g. unrecognized identifiers, drug-drug contraindications, drug-allergy alerts).

Examples:

  • High dosage alert

  • Conditional element missing

  • Timing detected issue

Property:   ConceptualSpaceForClassCode: ActClass.ALRT

3 . . . ActFinancialDetectedIssueCode

Definition:

Identifies types of detected issues for Act class "ALRT" for the financial acts domain.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . ClinicalActionDetectedIssueCode

Definition:

Identifies types of issues detected regarding the performance of a clinical action on a patient.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . MedicationIssueTypeCode

Definition:

Description: Any type of issue that identifies a potential adverse situation that would or might occur with the described substance administration.

Examples:

  • adverse effect
  • drug interaction
  • drug-food interaction

Property:   ConceptualSpaceForClassCode: ActClass.ALRT

4 . . . . DrugActionDetectedIssueCode

Definition:

Proposed therapy may be contraindicated or ineffective based on an existing or recent drug therapy

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ActObservationVerificationType
. .   ActObservationVerificationType (C1 as CWE)

Definition:

Identifies the type of verification investigation being undertaken with respect to the subject of the verification activity.

Examples:

  1. Verification of eligibility for coverage under a policy or program - aka enrolled/covered by a policy or program

  2. Verification of record - e.g., person has record in an immunization registry

  3. Verification of enumeration - e.g. NPI

  4. Verification of Board Certification - provider specific

  5. Verification of Certification - e.g. JAHCO, NCQA, URAC

  6. Verification of Conformance - e.g. entity use with HIPAA, conformant to the CCHIT EHR system criteria

  7. Verification of Provider Credentials

  8. Verification of no adverse findings - e.g. on National Provider Data Bank, Health Integrity Protection Data Base (HIPDB)

Property:   ConceptualSpaceForClassCode: ActClass.VERIF

2 . . ActPatientAnnotationCode
. .   ActPatientAnnotationType (R1 as CWE)

Definition:

Description:Provides a categorization for annotations recorded directly against the patient

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . ActPrivilegeCategorization

Definition:

An Act which characterizes a Privilege can have additional observations to provide a finer definition of the requested or conferred privilege. This domain describes the categories under which this additional information is classified.

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . ActPrivilegeCategorizationType

Definition:

This domain includes observations used to characterize a privilege, under which this additional information is classified.

Examples:A privilege to prescribe drugs has a RESTRICTION that excludes prescribing narcotics; a surgical procedure privilege has a PRE-CONDITION that it requires prior Board approval.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ActSecurityObjectCode

Definition:

Description:An access control object used to manage permissions and capabilities of users within information systems. (See HL7 RBAC specification fo examples of thes objects.)

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . AdverseSubstanceAdministrationEventActionTakenType

Definition:

Definition: Indicates the class of actions taken with regard to a substance administration related adverse event. This characterization offers a judgment of the practitioner"s response to the patient"s problem.

Examples: Example values include dose withdrawn, dose reduced, dose not changed.

NOTE: The concept domain is currently supported by a value set created by the International Conference on Harmonization

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . AgeObservationType
. .   LOINCObservationActContextAgeDefinitionCode (R1 as CWE)

Definition:

Categorization of types of observation that captures a person's age as a numeric quantity.

2 . . CommonClinicalObservationType

Definition:

Used in a patient care message to report and query simple clinical (non-lab) observations.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . CommonCodedClinicalObservationType

Definition:

Description: Identifies the type for a clinical observation whose value is expressed as a code.

Examples:

  • Home support level

  • Tumor staging

  • abdominal pain characteristic

4 . . . . CommonCodedClinicalObservationComponentType

Definition:

Description: Represents the components of a coded clinical observation.

Examples:

  • ability to articulate

  • ability to chop food

  • ability to crouch

2 . . CultureObservationType

Definition:

Description:To be used to code and identify the Microbiology laboratory orderable and resultable observation question.

Examples:

  • Urine; Culture
  • Deep Wound; Aerobic Culture
  • Microscopic Examination; Gram Stain

Property:   ConceptualSpaceForClassCode: ActClass.OBS

3 . . . OrganismIdentificationObservationType

Definition:

Description:To be used to code and identify the Microbiology laboratory observation code that relates to the microorganism identification.

Examples:

  • Bacteria identified
  • Bacteria identified in tissue
  • Fungus identified

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . DeviceCharacteristicObservationType

Definition:

Identifies characteristics (physical, visual, clinical) that may be observed for a particular device or device type.

Examples:

  • Height
  • Sterility
  • External diameter

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . DiagnosticImageCode

Definition:

Identifies the types of diagnostic image.

Examples: Echocardiogram, electocardiogram, X-ray.

2 . . DiagnosticImageReportObservationType

Definition:

Identifies the type of diagnostic image report.

Examples:

  • Echocardiogram Report
  • Ultrasound Report
  • Nuclear Medicine Imaging Report
2 . . DiseaseCategorizationObservationType

Definition:

Description: An observation that categorizes an existing observation of a disease, symptom or condition.

Usage Note: The act being categorized should be an observation of a disease, symptom or condition; the categorizing act should be an observation of the category of that disease, symptom or condition, and the relationship between the two acts should be a "has generalization" relationship.

Examples:

  • [Observation of] "thrombocytopenia" is categorized as an observation of "Haematologic system" category
  • [Observation of] "duodenal ulcer" is categorized as an observation of "Gastro-intestinal system" category
  • [Observation of] "eczema" is categorized as an observation of "Dermatologic system" category
2 . . ECGAnnotationType

Definition:

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ECGControlVariable

Definition:

OpenIssue: This concept domain has no valid description.

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . ECGObservationSequenceType

Definition:

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . EventFrequencyObservationType

Definition:

Description: Identifies types of observations that describe or categorize an observation in terms of the frequency of the observed event occurring.

Examples:

  • Very common
  • Uncommon
  • Rare
2 . . FDALabelData

Definition:

FDA label data

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . FinancialClinicalSupportingObservationType

Definition:

Description:Describes the supporting information for financial transactions such as a Special Authorization Request.

Example values under this concept domain could be: height, weight, duration of disease, site of fistula, etc.

This concept domain is intended to be used as part of a code/value pair within a generic structure that would convey ANY sort of information or proof of criteria that is needed to support a special authorization request.

2 . . GeneticObservationType
. .   GeneticObservationType (X1 as CWE)

Definition:

Description: Identifies the kinds of genetic observations that can be performed.

2 . . ICSRContextualObservationType

Definition:

Description: A type of observation on an investigative subject or a related entity that might be collected to provide the medical and social context for an adverse event report.

Examples:

  • Diagnosis

  • laboratory result

  • autopsy determined cause of death

2 . . ImmunizationForecastDate
. . [2.16.840.1.113883.1.11.82]

Definition:

Specifies the type of date that is specified in an immunization forecast. The immunization forecast defines the schedule for a vaccine based on variables like the subject's age, the type of vaccine, and the supply unit. The immunization forecast may involve multiple administrations in a series or just one administration. Each of the administrations has one or more recommended dates.

Examples:

  • Earliest recommended date
  • Recommended date
  • Latest acceptable date
  • Overdue date (date after which to start sending reminders)
2 . . ImmunizationObservationType
. .   ImmunizationObservationType (R1 as CWE)

Definition:

Description: Types of observations which describe characteristics of the immunization material.

2 . . IndividualCaseSafetyReportType
. .   IndividualCaseSafetyReportType (R1 as CWE)

Definition:

3 . . . ICSR_InvestigationAssessmentActType

Definition:

Description: Concepts that define the primary orientation of a product related investigation.

Examples:

  • Product defect

  • adverse event

OpenIssue:

Property:   ConceptualSpaceForClassCode: ActClass.ACT

3 . . . IndividualCaseSafetyReportCriteria

Definition:

Description: Includes those concepts that are provided to justify the fact that an adverse event or product problem is required to be reported in an expedited fashion.

Property:   ConceptualSpaceForClassCode: ActClass.INVSTG

3 . . . IndividualCaseSafetyReportProductCharacteristic

Definition:

Description: Includes relevant pieces of information about a product or its process of creation. The vocabulary domain is used to characterize products when they are cited in adverse event or product problem reports.

Examples:Weight, color, dimensions.

Property:   ConceptualSpaceForClassCode: ActClass.INVSTG

2 . . IsolateObservationType

Definition:

Description:To be used in the message when there is a requirement to communicate a result observation code that relates to a specific isolate.

Examples:

  • Colony count
  • Colony count; Viability count FDA method
  • Growth rate; Visual method

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . KnowledgeSubTopicObservationType
. .   KnowledgeSubtopicObservationCode (R1 as CWE)

Definition:

Categorization of types of observation that capture a knowledge subtopic which might be treatment, etiology, or prognosis.

2 . . KnowledgeSubjectObservationType
. .   KnowledgeSubjectObservationCode (R1 as CWE)

Definition:

Categorization of types of observation that capture the main clinical knowledge subject which may be a medication, a laboratory test, a disease.

2 . . MedicationObservationType
. .   ObservationType (C1 as CWE)

Definition:

Identifies types of observations that can be made about a particular drug or medication.

3 . . . MedicationSafetyReportObservationType

Definition:

Description: Identifies types of observations about the Safety Reports required for a particular medication.

Examples:

  • [Observation of] International Birth Date
  • [Observation of] Data Lock Point
  • [Observation of] Frequency of Safety Report Submission
3 . . . PhysicalCharacteristicsMedicationObservationType

Definition:

Identifies physical characteristics that may be observed for a particular medicinal product or medicinal product package of types thereof.

Examples:

  • Height
  • Imprint
  • Shape
  • Color
2 . . ObservationActAgeGroupType
. .   ObservationActContextAgeGroupType (R1 as CWE)

Definition:

Description:To allow queries to specify useful information about the age of the patient without disclosing possible protected health information.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationAllergyTestCode

Definition:

Description:Dianostic procedures ordered or performed to evaluate whether a sensitivity to a substance is present. This test may be associated with specimen collection and/or substance administration challenge actiivities.

Example:Skin tests and eosinophilia evaluations.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationAllergyTestType

Definition:

Indicates the type of allergy test performed or to be performed. E.g. the specific antibody or skin test performed

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationCaseStatusType

Definition:

Description: A code used to further identify the type of case status observation. Used with the OBS ActClass.

Examples:

  • Clinical status

  • Administrative status

  • Reporting status

2 . . ObservationCausalityAssessmentType

Definition:

Description:A kind of observation that allows a Secondary Observation (source act) to assert (at various levels of probability) that the target act of the association (which may be of any type of act) is implicated in the etiology of another observation that is named as the subject of the Secondary Observation

Example:Causality assertions where an accident is the cause of a symptom; predisposition assertions where the genetic state plus environmental factors are implicated in the development of a disease; reaction assertions where a substance exposure is associated with a finding of wheezing.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationCoordinateAxisType
. .   ObservationCoordinateAxisType (R1 as CWE)

Definition:

Description: Identifies the individual coordinate in the coordinate system inclusive of any transformations or projections.

Examples: meridian, range, township, longitude, latitude, lot, block, etc.

2 . . ObservationCoordinateSystemType
. .   ObservationCoordinateSystemType (R1 as CWE)

Definition:

Description: Identifies the coordinate system inclusive of any transformation projections.

2 . . ObservationDosageDefinitionPreconditionType

Definition:

Definition:

The set of observation type concepts that can be used to express pre-conditions to a particular dosage definition.

Rationale: Used to constrain the set of observations to those related to the applicability of a dosage, such as height, weight, age, pregnancy, liver function, kidney function, etc. For example, in drug master-file type records indicating when a specified dose is applicable.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationGenomicFamilyHistoryType

Definition:

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationIndicationType

Definition:

Includes all codes defining types of indications such as diagnosis, symptom and other indications such as contrast agents for lab tests

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationIntoleranceType

Definition:

Description: Types of sensitivity caused by an exposure to a substance which results in an abnormal immunologic or non-immunologic response.

Examples:

  • Food allergy
  • Environmental allergy
  • Fod intolerance
2 . . ObservationInvestigationType

Definition:

Description: Used to further classify the type of investigation being documented. This concept domain is intended to be used with the INVSTG Act class code.

Examples:

  • Public health case investigation

  • Safety investigation

  • Surveillance investigation

2 . . ObservationIssueTriggerCodedObservationType
. .   ObservationIssueTriggerCodedObservationType (C1 as CWE)

Definition:

Distinguishes the kinds of coded observations that could be the trigger for clinical issue detection. These are observations that are not measurable, but instead can be defined with codes. Coded observation types include: Allergy, Intolerance, Medical Condition, Pregnancy status, etc.

2 . . ObservationIssueTriggerMeasuredObservationType

Definition:

Distinguishes between the kinds of measurable observations that could be the trigger for clinical issue detection. Measurable observation types include: Lab Results, Height, Weight.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationLabReportType

Definition:

Description: A set of codes specifying the type of Laboratory Report.

Examples:

  • Hematology reports

  • Chemistry reports

  • Blood gas reports

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . ObservationOrderableType

Definition:

Description: Identifies the type of observations that can be ordered.

Examples:

  • lab tests

  • diagnostic imaging

  • device summary

Property:   ConceptualSpaceForClassCode: ActClass.OBS

3 . . . ObservationOrderableLabType

Definition:

Description: Identifies the ordered lab test. Also known as the lab order code or test code.

Examples:

  • red blood cell count

  • components of a chemistry panel

  • microbiology sensitivity testing

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . ObservationOutbreakExtentType

Definition:

Description: A code used to further identify the type of Outbreak Extent Observation. Used with the OBS ActClass.

Examples:

  • Geographic extent

  • Jurisdictional extent

2 . . ObservationPositionAccuracyType

Definition:

Description: Identifies the type of position accuracy carried in observation value.

2 . . ObservationPublicHealthCaseType

Definition:

Definition:Identifies the kinds of public health cases. Used only with the CASE Act class code.

Examples of types of public health cases includes reportable disease cases, radiation exposure cases and chemical exposure cases.

2 . . ObservationPublicHealthOutbreakType

Definition:

Description:

Used to further classify the type of Outbreak being documented. This concept domain is intended to be used with the OUTB Act class code.

Examples:

  • Epidemic

  • Pandemic

  • Endemic

2 . . ObservationQualityMeasureAttributeType
. .   ObservationQualityMeasureAttribute (R1 as CWE)

Definition:

Codes used to define various metadata aspects of a health quality measure (specialization of ActClass "OBS").

2 . . ObservationQueryMatchType

Definition:

Definition: An observation related to a query response.

Example:The degree of match or match weight returned by a matching algorithm in a response to a query.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . ObservationResultableType

Definition:

Description: Identifies the type of observation that can be resulted. There are some labs which are not ordered and are performed and resulted when the outcome of an ordered test meets some criteria.

Examples:

  • outcomes of lab tests

  • device summary

  • therapeutic drug level testing

Property:   ConceptualSpaceForClassCode: ActClass.OBS

3 . . . ObservationResultableLabType

Definition:

Description: The type of lab observation being resulted. There are some lab tests which are not ordered and are performed and resulted when the outcome of an ordered test meets some criteria.

Examples:

  • red blood cell count

  • results of micro sensitivity testing

  • Missing third example

2 . . ObservationVisionPrescriptionType

Definition:

Definition: Identifies the type of Vision Prescription Observation that is being described.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . PatientCharacteristicObservationType

Definition:

Indicates the type of characteristics a patient should have for a given therapy to be appropriate. E.g. Weight, Age, certain lab values, etc.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . PatientImmunizationRelatedObservationType
. .   PatientImmunizationRelatedObservationType (X1 as CWE)

Definition:

Description: Reporting codes that are related to an immunization event.

2 . . PopulationInclusionObservationType
. .   PopulationInclusionObservationType (R1 as CWE)

Definition:

Observation types for specifying criteria used to assert that a subject is included in a particular population.

Examples:

  • denominator
  • numerator
  • initial population
2 . . PrescriptionObservationType

Definition:

Observations specific to a particular prescription to express concepts that cannot be expressed via other modeling approaches.

Examples: "Patient Medication On Hand Quantity", "Patient Medication On Hand Days Supply", "Patient Expected Supply Run-out Date", "Percentage Dispensed".

2 . . SecurityObservationType
. .   SecurityObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about an IT resource (data, information object, service, or system capability), which may be used to make access control decisions. Security metadata are used in security labels.

Rationale: According to ISO/TS 22600-3:2009(E) A.9.1.7 SECURITY LABEL MATCHING, Security label matching compares the initiatorís clearance to the targetís security label. All of the following must be true for authorization to be granted:

  • The security policy identifiers shall be identical,
  • The classification level of the initiator shall be greater than or equal to that of the target (that is, there shall be at least one value in the classification list of the clearance greater than or equal to the classification of the target), and
  • For each security category in the target label, there shall be a security category of the same type in the initiatorís clearance and the initiatorís classification level shall dominate that of the target.

Usage Note: SecurityObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the securty label tag set "SecurityObservationValue" value set.

3 . . . SecurityCategoryObservationType
. . .   SecurityCategoryObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the category of an IT resource (data, information object, service, or system capability), which may be used to make access control decisions. Security category metadata is defined by ISO/IEC 2382-8:1998(E/F)/ T-REC-X.812-1995 as: "A nonhierarchical grouping of sensitive information used to control access to data more finely than with hierarchical security classification alone."

Rationale: A security category observation supports the requirement to specify the type of IT resource in order to facilitate application of appropriate levels of security according to a range of levels of impact or consequences that might result form the unauthorized disclosure, modification, or use of the information or information system. A resource is assigned to a specific category of information (e.g., privacy, medical, proprietary, financial, investigative, contractor sensitive, security management) defined by an organization or in some instances, by a specific law, Executive Order, directive, policy, or regulation. [FIPS 188]

Examples: Types of security categories include:

  • Compartment: A division of data into isolated blocks with separate security controls for the purpose of reducing risk. (ISO 2382-8). Security label metadata that "segments" an IT resource by indicating that access and use is restricted to members of a defined community or project. (HL7 Healthcare Classification System)
  • Sensitivity: The characteristic of a resource which implies its value or importance and may include its vulnerability. (ISO 7492-2) Privacy metadata for information perceived as undesirable to share. (HL7 Healthcare Classification System)

Usage Note: SecurityCategoryObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tage set "SecurityCategoryObservatonValue" value set.

Codes may be drawn from the union of the following value sets: V:PrivacyPolicyType, V:ActPrivacyLaw, V:ActConsentDirective, V:InformationSensitivityPolicy, V:ActInformationSensitivityPolicy, V:RoleInformationSensitivityPolicy, EntitySensitivityPolicy, and V:ActConsentType. Could be bound R1 to a V:ActUSPrivacyPolicy in a future US Realm.

3 . . . SecurityClassificationObservationType
. . .   SecurityClassificationObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the classification of an IT resource (data, information object, service, or system capability), which may be used to make access control decisions. Security classification is defined by ISO/IEC 2382-8:1998(E/F)/ T-REC-X.812-1995 as: "The determination of which specific degree of protection against access the data or information requires, together with a designation of that degree of protection." Security classification metadata is based on an analysis of applicable policies and the risk of harm to an individual that could result from unauthorized disclosure.

Examples: Types of security classification include: HL7 Confidentiality Codes such as very restricted, unrestricted, and normal. Intelligence community examples include top secret, security, and confidential.

Usage Note: SecurityClassificationObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityClassificationObservationValue" value set.

Note that an Act or Role may be associated with an Observation coded as SecurityClassificationObservationType with a SecurityClassificationObservationValue coded with a confidentiality code from V:Confidentiality Code to indicate that the confidentiality level indicated by an Act or Role confidentiality attribute has been overridden by the entity responsible for assigning the SecurityClassificationObservationValue. This supports the business requirement for increasing or decreasing the level of confidentiality (classification or declassification) based on parameters beyond the original assignment of an Act or Role confidentiality.

3 . . . SecurityControlObservationType
. . .   SecurityControlObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the control of an IT resource (data, information object, service, or system capability), which may be used to make access control decisions. Security control metadata convey instructions to users and receivers for secure distribution, transmission,and storage; dictate obligations or mandated actions; specify any action prohibited by refrain policy such as dissemination controls; and stipulate the permissible purpose of use of an IT resource.

Examples: Types of security control metadata include handling:

  • caveats
  • dissemination controls
  • obligations
  • refrain policies
  • purpose of use constraints

Usage Note: SecurityControlObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityControlObservationValue" value set. Codes may be drawn from the union of the following value sets: V:SecurityPolicy, V:ObligationiPolicy, V:RefrainPolicy, V:PurposeOfUse, and V:GeneralPurposeOfUse.

3 . . . SecurityIntegrityObservationType

Definition:

Type of security metadata observation made about the integrity of an IT resource (data, information object,service, or system capability), which may be used to make access control decisions.

Rationale: Integrity security label fields support integrity models such as the Biba Integrity Model, the Lipner Full Integrity Model, and the Clar-Wilson Model. The value in the integrity label field indicates the degree of confidence that may be placed in the data and also indicates which measures the data requires for protection from modification and destruction.

Examples: Types of security integrity observation metadata, which may value the observation include:

  • Integrity status, which indicates the completeness or workflow status of a resource (data, information object, service, or system capability);
  • Integrity confidence, which indicates the reliability and trustworthiness of the resource;
  • Integrity control, which indicates pertinent handling caveats, obligations, refrain policies, and purpose of use for the resource;
  • Data integrity, which indicate the security mechanisms used to ensure that the accuracy and consistency are preserved regardless of changes made (ISO/IEC DIS 2382-8);
  • Alteration integrity, which indicate the security mechanisms used for authorized transformations of the resource;
  • Integrity provenance, which indicates the second-hand origins of a reported or asserted resource.

Usage Note: SecurityIntegrityObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityIntegrityObservationValue" value set.

4 . . . . SecurityAlterationIntegrityObservationType
. . . .   SecurityAlterationIntegrityObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the alteration integrity of an altered IT resource (data, information object, service, or system capability), which indicates the mechanism used for authorized transformation of the resource.

Examples: Types of security alteration integrity observation metadata, which may value the observation with a code used to indicate the mechanism used for authorized transformation of an IT resource, include:

  • translation
  • syntactic transformation
  • semantic mapping
  • redaction
  • masking
  • pseudonymization
  • anonymization

Usage Note: SecurityAlterationIntegrityObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityAlterationIntegrityObservationValue" value set, which convey the mechanism used for authorized transformation of an IT resource.

4 . . . . SecurityDataIntegrityObservationType
. . . .   SecurityDataIntegrityObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the data integrity of an IT resource (data, information object, service, or system capability), which indicates the security mechanism used to preserve resource accuracy and consistency. Data integrity is defined by ISO 22600-23.3.21 as: "The property that data has not been altered or destroyed in an unauthorized manner", and by ISO/IEC 2382-8: "The property of data whose accuracy and consistency are preserved regardless of changes made."

Rationale: In accordance with the HL7 RM-ES EHR-FM Profile Standard: The validity of a patient record entry requires an indelible statement (e.g., attestation or electronic signature) by the author(s) of completeness, accuracy, and affirmation that the record cannot be repudiated, assigning each author to his/her actual contributed content.

Examples: Types of security data integrity observation metadata, which may value the observation, include:

  • cryptographic hash function
  • digital signature

Usage Note: SecurityDataIntegrityObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityIntegrityConfidenceObservationValue" value set.

4 . . . . SecurityIntegrityConfidenceObservationType
. . . .   SecurityIntegrityConfidenceObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the integrity confidence of an IT resource (data, information object,service, or system capability) that indicates the reliability or trustworthiness of a resource, which may be used to make access control decisions.

Examples: Types of security integrity confidence observation metadata, which may value the observation, include:

  • highly reliable
  • uncertain reliability
  • not reliable

Usage Note: A security integrity confidence observation on an Act may indicated that a valued Act.uncertainty attribute has been overridden by the entity responsible for assigning the SecurityIntegrityConfidenceObservationValue. This supports the business requirements for increasing or decreasing the assessment of the reliability or trustworthiness of an IT resource based on parameters beyond the original assignment of an Act.uncertaintyCode.

4 . . . . SecurityIntegrityProvenanceObservationType
. . . .   SecurityIntegrityProvenanceObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the provenance integrity of an IT resource (data, information object, service, or system capability), which indicates the lifecycle completeness and workflow status of an IT resource, such as create, modify, append, amend, suspend, archive, and delete; locations in which the resource has been collected or archived, from which it may be retrieved, and the history of its distribution and disclosure. Integrity provenance metadata about an IT resource may be used to assess its veracity, reliability, and trustworthiness.

Examples: Types of security integrity provenance observation metadata, which may value the observation with a code used to indicate provenance, include the entity responsible for a report or assertion relayed "second-hand" about an IT resource.

Usage Note: SecurityIntegrityProvenanceObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityIntegrityProvenanceObservationValue" value set.

5 . . . . . SecurityIntegrityProvenanceAssertedByObservationType
. . . . .   SecurityIntegrityProvenanceAssertedByObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the provenance integrity of an IT resource (data, information object, service, or system capability), which indicates the entity responsible for an assertion relayed "second-hand" about an IT resource.

Rationale: In accordance with HL7 RM-ES EHR-FM Profile at IN:1.8: If more than one author contributed to the EHR content, then the system shall provide the ability to associate and maintain all authors/contributors with their content.

Examples: Types of security integrity provenance asserted by observation metadata, which may value the observation, include assertions about an IT resource by a patient, a clinician, or a device.

Usage Note: SecurityIntegrityProvenanceAssertedByObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityIntegrityProvenanceAssertedByObservationValue" value set.

5 . . . . . SecurityIntegrityProvenanceReportedByObservationType
. . . . .   SecurityIntegrityProvenanceReportedByObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the provenance integrity of an IT resource (data, information object, service, or system capability), which indicates the entity responsible for a report relayed "second-hand" about an IT resource.

Rationale: In accordance with HL7 RM-ES EHR-FM Profile at IN:1.8: If more than one author contributed to the EHR content, then the system shall provide the ability to associate and maintain all authors/contributors with their content.

Examples: Types of security integrity provenance observation metadata, which may value the observation with a code used to indicate provenance, include reports about an IT resource by a patient, a clinician, or a device.

Usage Note: SecurityIntegrityProvenanceReportedByObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityIntegrityProvenanceReportedByObservationValue" value set.

4 . . . . SecurityIntegrityStatusObservationType
. . . .   SecurityIntegrityStatusObservationType (R1 as CWE)

Definition:

Type of security metadata observation made about the integrity status of an IT resource (data, information object,service, or system capability), which may be used to make access control decisions. Indicates the completeness or workflow status of an IT resource, which may impact which users that are authorized to access and use the resource.

Rationale: In accordance with the HL7 RM-ES Profile Standard: The validity of a patient record entry requires an indelible statement (e.g., attestation or electronic signature) by the author(s) of completeness, accuracy, and affirmation that the record cannot be repudiated, assigning each author to his/her actual contributed content.

Examples: Types of security integrity status observation metadata, which may value the observation, include codes from the HL7 DocumentCompletion value set such as:

  • legally authenticated
  • in progress
  • incomplete

Usage Note: SecurityIntegrityStatusObservationType concept domain designates a code system used to name a security label field type that may be valued with a "security label tag" such as a code from the security label tag set "SecurityIntegrityStatusObservationValue" concept domain, which may be valued with coded concepts from the HL7 DocumentCompletion value set.

2 . . SeverityObservationType
. .   SeverityObservationCode (R1 as CWE)

Definition:

Categorization of types of observation that capture the interpretation of the result of a laboratory test in terms of normality.

2 . . SimpleMeasurableClinicalObservationType

Definition:

Types of measurement observations typically performed in a clinical (non-lab) setting. E.g. Height, Weight, Blood-pressure

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . SimpleMeasurableClinicalObservationComponentType

Definition:

Description: Represents the components of a measured clinical observation.

Examples:

  • the systolic and diastolic components of a blood pressure

  • 24-hour urine output

  • ARAC gene

2 . . SubstanceCharacteristicObservationType

Definition:

Distinguishing traits, qualities, or properties given about substances, including chemical structure (as encapsulated data in SMILES, MolFile, InChi), nucleic acid sequence, amino acid sequence, molecular sum formula; molecular mass; stereochemistry and optical activity properties; viscosity; pH, pKa, catalytic activity, etc.

2 . . SusceptibilityBatteryType

Definition:

Description:Ensures consistent coding of the susceptibility battery or panel.

Examples:

  • Bacterial susceptibility panel
  • Fungal susceptibility panel
  • Mycobacterial susceptibility panel
  • Viral susceptibility panel

Property:   ConceptualSpaceForClassCode: ActClass.OBS

2 . . SusceptibilityObservationType

Definition:

Description:Ensures consistent coding of antimicrobial information in the Microbiology lab message.

Examples:

  • Ciprofloxacin; Disk Diffusion (Kirby-Bauer)
  • Vancomycin
  • Tetracycline; Minimum Inhibitory Concentration

Property:   ConceptualSpaceForClassCode: ActClass.OBS

1 RegulationPolicyActType
 RegulationPolicyActCode (R1 as CWE)

Definition:

Description: A rule set by regulators of product that somehow constrain the use of products. Regulator may be any organization with a mandate to issue such rules, regardless of level, regional, country, state, and local (e.g., an institutional Pharmaceutical and Treatment Committee.)

Examples:

  • Prescription Only

  • Controlled Substance Schedule II

  • Standard of Practice

Property:   ConceptualSpaceForClassCode: ActClass.POLICY

1 ResearchStudyType

Definition:

Description: Different types of research studies that may be conducted and reported on.

Examples:

  • Observational
  • Investigational

Property:   ConceptualSpaceForClassCode: ActClass.INVSTG


Return to concept domain index
ActContextLevel     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActContextLevel Act .levelCode (CD)

Definition:

Description: Code specifying the level within a hierarchical Act composition structure and the kind of contextual information attached to composite Acts ("containers") and propagated to component Acts within those containers. The levelCode signifies the position within such a containment hierarchy and the applicable constraints.

Examples: The "extract level" and the "folder level" must contain data about a single individual, whereas the "multiple subject level" may contain data about multiple individuals. While "extract" can originate from multiple sources, a "folder" should originate from a single source. The "composition" level usually has a single author.

Constraints: The constraints applicable to a particular level may include differing requirements for participations (e.g. patient, source organization, author or other signatory), relationships to or inclusion of other Acts, documents or use of templates. The constraints pertaining to a level may also specify the permissible levels that may be contained as components of that level. Several nested levels with the same levelCode may be permitted, prohibited (or limited). Instance of the next subordinate level are usually permitted within any level but some levels may be omitted from a model and it may be permissible to skip several layers.

Discussion: The levelCode concepts have been defined to meet specific health record transfer requirements. While these concepts are known to be applicable to some other types of transactions, they are not intended to a be a complete closed list. Options exist for other sets of orthogonal levels where required to meet a business purpose (e.g. a multiple patient communication may be subdivided by a super-ordinate level of subject areas).


Return to concept domain index
ActExposureLevelCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActExposureLevelCode
 ActExposureLevelCode (X1 as CWE)
Exposure .exposureLevel (CD)

Definition:

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.


Return to concept domain index
ActInvoiceElementModifier     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActInvoiceElementModifier
 ActInvoiceElementModifier (R1 as CWE)

Definition:

Processing consideration and clarification codes.


Return to concept domain index
ActIssuePriority     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActIssuePriority
 AcknowledgementDetailType (R1 as CWE)

Definition:

Indicates the importance or priority associated with a detected issue.


Return to concept domain index
ActMood     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActMood
 ActMood (UV as CNE)
Act .moodCode (CS)

Definition:

A code distinguishing whether an Act is conceived of as a factual statement or in some other manner as a command, possibility, goal, etc.

Constraints: An Act-instance must have one and only one moodCode value.

The moodCode of a single Act-instance never changes. Mood is not state.

To describe the progression of a business activity from defined to planned to executed, etc. one must instantiate different Act-instances in the different moods and link them using ActRelationship of general type "sequel". (See ActRelationship.type.)

Discussion: The Act.moodCode includes the following notions: (1) event, i.e., factual description of an actions that occurred; (2) definition of possible actions and action plans (the master file layer); (3) intent, i.e., an action plan instantiated for a patient as a care plan or order; (4) goal, i.e., an desired outcome attached to patient problems and plans; and (5) criterion, i.e., a predicate used as

The Act.moodCode modifies the meaning of the Act class in a controlled way, just as in natural language, grammatical form of a verb modify the meaning of a sentence in defined ways. For example, if the mood is factual (event,) then the entire act object represents a known fact. If the mood expresses a plan (intent,) the entire act object represents the expectation of what should be done. The mood does not change the meaning of individual act properties in peculiar ways.

Since the mood code is a determining factor for the meaning of an entire Act object, the mood must always be known. This means, whenever an act object is instantiated, the mood attribute must be assigned to a valid code, and the mood assignment can not change throughout the lifetime of an act object.

As the meaning of an act object is factored in the mood code, the mood code affects the interpretation of the entire Act object and with it every property (attributes and associations.) Note that the mood code affects the interpretation of the act object, and the meaning of the act object in turn determines the meaning of the attributes. However, the mood code does not arbitrarily change the meaning of individual attributes.

Inert vs. descriptive properties of Acts: Acts have two kinds of act properties, inert and descriptive properties. Inert properties are not affected by the mood, descriptive properties follow the mood of the object. For example, there is an identifier attribute Act.id, which gives a unique identification to an act object. Being a unique identifier for the object is in no way dependent on the mood of the act object. Therefore, the "interpretation" of the Act.id attribute is inert with respect to the act object's mood.

By contrast, most of the Act class' attributes are descriptive for what the Act statement expresses. Descriptive properties of the Act class give answer to the questions who, whom, where, with what, how and when the action is done. The questions who, whom, with what, and where are answered by Participatons, while how and when is answered by descriptive attributes and ActRelationships. The interpretation of a descriptive attribute is aligned to the interpretation of the entire act object, and controlled by the mood.

Examples: To illustrate the effect of mood code, consider a "blood glucose" observation:

The DEFINITION mood specifies the Act of "obtaining blood glucose". Participations describe in general the characteristics of the people who must be involved in the act, and the required objects, e.g., specimen, facility, equipment, etc. involved. The Observation.value specifies the absolute domain (range) of the observation (e.g., 15-500 mg/dl.)

In INTENT mood the author of the intent expresses the intent that he or someone else "should obtain blood glucose". The participations are the people actually or supposedly involved in the intended act, especially the author of the intent or any individual assignments for group intents, and the objects actually or supposedly involved in the act (e.g., specimen sent, equipment requirements, etc.) The Observation.value is usually not specified, since the intent is not to measure blood glucose, not to measure blood glucose in a specific range. (But compare with GOAL below.)

In ORDER mood, a kind of intent, the author requests to "please obtain blood glucose". The Participations are the people actually and supposedly involved in the act, especially the placer and the designated filler, and the objects actually or supposedly involved in the act (e.g., specimen sent, equipment requirements, etc.) The Observation.value is usually not specified, since the order is not to measure blood glucose in a specific range.

In EVENT mood, the author states that "blood glucose was obtained". Participations are the people actually involved in the act, and the objects actually involved (e.g., specimen, facilities, equipment.) The Observation.value is the value actually obtained (e.g., 80 mg/dL, or <15 mg/dL.)

In event-CRITERION mood, an author considers a certain class of "obtaining blood glucose" possibly with a certain value (range) as outcome. The Participations constrain the criterion, for instance, to a particular patient. The Observation.value is the range in which the criterion would hold (e.g. > 180 mg/dL or 200?300 mg/dL.)

In GOAL mood (a kind of criterion) the author states that "our goal is to be able to obtain blood glucose with the given value (range)". The Participations are similar to intents, especially the author of the goal and the patient for whom the goal is made. The Observation.value is the range which defined when the goal is met (e.g. 80?120 mg/dl.)

Rationale: The notion of "mood" is borrowed from natural language grammar, the mood of a verb (lat. modus verbi).

The notion of mood also resembles the various extensions of the logic of facts in modal logic and logic with modalities, where the moodCode specifies the modality (fact, possibility, intention, goal, etc.) under which the Act-statement is judged as appropriate or defective.

1 ActMoodProposal
 ActMoodProposal (C1 as CNE)

Definition:

A non-mandated intent to perform an act. Used to record intents that are explicitly not Orders. Professional responsibility for the 'proposal' may or may not be present.


Return to concept domain index
ActPriority     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActPriority
 ActPriority (R1 as CWE)
Act .priorityCode (DSET<CD>)

Definition:

A code or 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.

Discussion: This attribute is used in orders to indicate the ordered priority, and in event documentation it indicates the actual priority used to perform the act. In definition mood it indicates the available priorities.

1 ActEncounterPriority
 x_EncounterAdmissionUrgency (R1 as CWE)

Definition:

Description: Types of priorities to determine start of an encounter.


Return to concept domain index
ActReason     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActReason Act .reasonCode (DSET<CD>)

Definition:

A code specifying the motivation, cause, or rationale of an Act, when such rationale is not reasonably representable 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".

Discussion

Most reasons for acts can be clearly expressed by linking the new Act to another prior Act using an ActRelationship of type "has reason". This simply states that the prior Act is a reason for the new Act (see ActRelationship.) The prior act can then be a specific existing act or a textual explanation. This works for most cases, and the more specific the reason data is, the more should this reason ActRelationship be used instead of the reasonCode.

The reasonCode remains as a place for common reasons that are not related to a prior Act or any other condition expressed in Acts. Indicators that something was required by law or was on the request of a patient etc. may qualify. However, if that piece of legislation, regulation, or the contract or the patient request can be represented as an Act (and they usually can), the reasonCode should not be used.

1 ActAdjudicationReason

Definition:

Explanatory codes that describe reasons why an Adjudicator has financially adjusted an invoice (claim).

A companion domain (ActAdjudicationInformationCode) includes information reasons which do not have a financial impact on an invoice (claim).

Example adjudication reason code is AA-CLAIM-0011 - Only Basic Procedure/Test Eligible.

Codes from this domain further rationalizes ActAdjudicationCodes (e.g. AA - Adjudicated with Adjustment), which are used to describe the process of adjudicating an invoice. For AS - Adjudicated as Submitted, there should be no specification of ActAdjudicationReason codes, as there are no financial adjustments against the invoice.

1 ActAntigenInvalidReason
 ActAntigenInvalidReason (R1 as CWE)

Definition:

Description: Describe why an antigen is considered to be invalid for use.

1 ActBillableServiceReason

Definition:

Definition: This domain is used to document reasons for providing a billable service; the billable services may include both clinical services and social services.

2 . . ActBillableClinicalServiceReason

Definition:

Description: May be sent to indicate one or more reasons for the performance of a billable clinical service or product, and not related or specified by a diagnosis.

Examples:

  • Duplicate Therapy

  • Care protocol

  • Insurance requirement

3 . . . MedicallyNecessaryDuplicateProcedureReason

Definition:

Definition: This domain is used to document why the procedure is a duplicate of one ordered/charged previously for the same patient within the same date of service and has been determined to be medically necessary.

Example: A doctor needs a different view in a chest X-Ray.

2 . . ActBillableNonClinicalServiceReason

Definition:

Description: Maybe sent to indicate one or more reasons for the performance of a non clinical service or product, and not related or specified by diagnosis.

Examples:

  • Fraudulent prescription

  • Patient's preference

  • Physiotherapy equipment

3 . . . NonClinicalDuplicateServiceReason

Definition:

Description: A duplicate non-clinical service or product is being re-billed.

Examples:

  • Duplicate transportation required for physician visit

  • Wrong size of a product

  • Rebuilding wheel chair ramp due to a weather condition

1 ActCoverageLevelRasonCode

Definition:

Description:Represents the reason for the level of coverage provided under the policy or program in terms of the types of entities that may play covered parties based on their personal relationships or employment status.

1 ActCoverageReason
 ActCoverageReason (C1 as CWE)

Definition:

Description:Codes used to specify reasons or criteria relating to coverage provided under a policy or program. May be used to convey reasons pertaining to coverage contractual provisions, including criteria for eligibility, coverage limitations, coverage maximums, or financial participation required of covered parties.

2 . . ActCoverageProviderReason

Definition:

Description:Identifies the reason or rationale for coverage of a service or product based on characteristics of the provider, e.g., contractual relationship to payor, such as in or out-of-network; relationship of the covered party to the provider.

Example:In closed managed care plan, a covered party is assigned a primary care provider who provides primary care services and authorizes referrals and ancillary and non-primary care services.

2 . . ActCoverageServiceReason

Definition:

Description:Identifies the reason or rationale for coverage of a service or product based on clinical efficacy criteria or practices prescribed by the payor.

2 . . CoverageExclusionReason

Definition:

Description:Identifies the reason or rationale for coverage of a service or product based on coverage exclusions related the risk of adverse selection by covered parties.

2 . . CoverageFinancialParticipationReason

Definition:

Description:Identifies the reason or rationale for coverage of a service or product based on financial participation responsibilities of the covered party.

2 . . CoverageLimitationReason

Definition:

Description:Identifies the reason or rationale for limitations on the coverage of a service or product based on coverage contract provisions.

Example:The maximum cost per unit; or the maximum number of units per period, which is typically the policy or program effective time.

2 . . EligibilityActReasonCode
. .   EligibilityActReasonCode (C1 as CWE)

Definition:

Identifies the reason or rational for why a person is eligibile for benefits under an insurance policy or progam.

Examples: A person is a claimant under an automobile insurance policy are client deceased & adopted client has been given a new policy identifier. A new employee is eligible for health insurance as an employment benefit. A person meets a government program eligibility criteria for financial, age or health status.

3 . . . CoverageEligibilityReason
. . .   CoverageEligibilityReason (C1 as CWE)

Definition:

Definition: Identifies the reason or rational for why a person is eligibile for benefits under an insurance policy or progam.

Examples: A person is a claimant under an automobile insurance policy are client deceased & adopted client has been given a new policy identifier. A new employee is eligible for health insurance as an employment benefit. A person meets a government program eligibility criteria for financial, age or health status.

1 ActEncounterReason
 x_ActEncounterReason (R1 as CWE)

Definition:

Description: Administration reasons for patient encounters.

1 ActImmunizationReason

Definition:

1 ActInformationManagementReason

Definition:

Description: The rationale or purpose for an act relating to information management, such as archiving information for the purpose of complying with an enterprise data retention policy.

2 . . ActHealthInformationManagementReason
. .   ActHealthInformationManagementReason (R1 as CWE)

Definition:

Description: The rationale or purpose for an act relating to health information management, such as archiving information for the purpose of complying with an organization policy or jurisdictional law relating to data retention.

3 . . . ActConsentInformationAccessOverrideReason
. . .   ActConsentInformationAccessOverrideReason (C1 as CWE)

Definition:

To perform one or more operations on information to which the patient has not consented as deemed necessary by authorized entities for providing care in the best interest of the patient; providing immediately needed health care for an emergent condition; or for protecting public or third party safety.

Usage Notes: Used to convey the reason that a provider or other entity may or has accessed personal healthcare information. Typically, this involves overriding the subject's consent directives.

3 . . . ActHealthInformationPrivacyReason

Definition:

Description: The rationale or purpose for an act relating to the management of personal health information, such as collecting personal health information for research or public health purposes.

3 . . . ActHealthInformationPurposeOfUseReason
. . .   GeneralPurposeOfUse (R1 as CWE)
. . .   PurposeOfUse (R1 as CWE)

Definition:

Reason for performing one or more operations on information, which may be permitted by source system's security policy in accordance with one or more privacy policies and consent directives.

Usage Notes: The rationale or purpose for an act relating to the management of personal health information, such as collecting personal health information for research or public health purposes.

2 . . ActInformationAccessOverrideReason

Definition:

Description: Use to convey the reason that a provider may or has accessed personal healthcare information. Typically, this involves overriding the subject's consent directives.

1 ActInformationPrivacyReason

Definition:

Description: The rationale or purpose for an act relating to the management of personal information, such as disclosing personal tax information for the purpose of complying with a court order.

1 ActNoImmunizationReason
 ActNoImmunizationReason (C1 as CWE)

Definition:

1 ActPaymentReason

Definition:

OpenIssue:

1 ActRPSRelatedApplicationReason

Definition:

Identifies the reason for citing a related application.

Examples:

  • Data protection period expiry reference
  • Bioequivalence reference
  • Drug Master File reference

Usage Note: This usage is confined to a specific set of requirements related to regulatory documents in the context of RPS documents.

1 ActSupplyFulfillmentRefusalReason
 ActSupplyFulfillmentRefusalReason (C1 as CWE)

Definition:

Indicates why a fulfiller refused to fulfill a supply order, and considered it important to notify other providers of their decision. E.g. "Suspect fraud", "Possible abuse", "Contraindicated".

(used when capturing 'refusal to fill' annotations)

1 ClinicalResearchReason

Definition:

Definition:Contains domains for act reasons used in clinical research.

2 . . ClinicalResearchEventReason

Definition:

Definition:Specifies the reason that an event occurred in a clinical research study.

2 . . ClinicalResearchObservationReason

Definition:

Definition:SSpecifies the reason that a test was performed or observation collected in a clinical research study.

Note:This set of codes are not strictly reasons, but are used in the currently Normative standard. Future revisions of the specification will model these as ActRelationships and thes codes may subsequently be retired. Thus, these codes should not be used for new specifications.

1 ControlActReason
 ControlActReason (R1 as CWE)

Definition:

Description: Indicates the motivation, cause or rationale of an Act which results in a trigger event.

2 . . CombinedPharmacyOrderSuspendReasonCode
. .   CombinedPharmacyOrderSuspendReasonCode (C1 as CWE)

Definition:

Description:Indicates why the prescription should be suspended.

2 . . ConrolActNullificationReasonCode

Definition:

Description:Identifies reasons for nullifying (retracting) a particular control act.

Examples:"Entered in error", "altered decision", etc.

2 . . ControlActNullificationReasonCode
. .   ControlActNullificationReasonCode (C1 as CWE)

Definition:

Description:Identifies reasons for nullifying (retracting) a particular control act.

Examples:"Entered in error", "altered decision", etc.

2 . . ControlActNullificationRefusalReasonType
. .   ControlActNullificationRefusalReasonType (R1 as CWE)

Definition:

Description: Indicates why a specific transaction which was requested to be undone; was not undone.

2 . . ControlActReasonConditionNullify

Definition:

Indicates why the ConditionaTMs status was changed to Nullified. Examples administrative error, diagnostic error.

2 . . GenericUpdateReasonCode
. .   GenericUpdateReasonCode (R1 as CWE)

Definition:

Description:Identifies why a change is being made to a record.

2 . . MedicationOrderAbortReasonCode
. .   MedicationOrderAbortReasonCode (C1 as CWE)

Definition:

Description:Indicates the reason the medication order should be aborted.

2 . . MedicationOrderReleaseReasonCode
. .   MedicationOrderReleaseReasonCode (C1 as CWE)

Definition:

Definition:A collection of concepts that indicate why the prescription should be released from suspended state.

2 . . PatientProfileQueryReasonCode
. .   PatientProfileQueryReasonCode (C1 as CWE)

Definition:

Definition:A collection of concepts identifying why the patient's profile is being queried.

2 . . PharmacySupplyEventAbortReasonType
. .   PharmacySupplyEventAbortReason (R1 as CWE)

Definition:

Definition:Identifies why the dispense event was not completed

2 . . PharmacySupplyEventStockReasonCode
. .   PharmacySupplyEventStockReasonCode (C1 as CWE)

Definition:

Definition:A collection of concepts that indicates the reason for a "bulk supply" of medication.

2 . . PharmacySupplyRequestFulfillerRevisionRefusalReasonCode

Definition:

Definition:Indicates why the request to transfer a prescription from one dispensing facility to another has been refused.

2 . . PharmacySupplyRequestRenewalRefusalReasonCode
. .   PharmacySupplyRequestRenewalRefusalReasonCode (R1 as CWE)

Definition:

Identifies the reason why a request for a prescription renewal has been refused.

2 . . StatusRevisionRefusalReasonType
. .   StatusRevisionRefusalReasonCode (R1 as CWE)

Definition:

Indicates why the act revision (status update) is being refused.

2 . . SubstanceAdministrationPermissionRefusalReasonCode
. .   SubstanceAdministrationPermissionRefusalReasonCode (R1 as CWE)

Definition:

Definition:Indicates why the requested authorization to prescribe or dispense a medication has been refused.

2 . . SupplyOrderAbortReasonCode
. .   SupplyOrderAbortReasonCode (R1 as CWE)

Definition:

Indicates why the prescription should no longer be allowed to be dispensed (but can still administer what already has been dispensed).

UsageNote: This is typically used in the scenario where the prescription allows for repeats or refills.

1 NonPerformanceReasonCode

Definition:

The reason the action was not performed, e.g. why the medication was not taken. If an action was not performed, it is often clinically important to know why the action was not taken.

Examples:Patient refused, clinically inappropriate, absolute contraindication etc.

1 ReasonForNotEvaluatingDevice

Definition:

Code assigned to indicate the rationale for not performing an evaluation investigation on a device for which a defect has been reported.

Examples include: device received in a condition that made analysis impossible, device evaluation anticipated but not yet begun, device not made by company.

1 ReferralReasonCode

Definition:

The reason a referral was made.

Examples:Specialized Medical Assistance, Other Care Requirements.

1 RefusalReasonCode
 RefusalReasonCode (R1 as CWE)

Definition:

Description: Identifies why a request to add (or activate) a record is being refused. Examples include the receiving system not able to match the identifier and find that record in the receiving system, having no permission, or a detected issue exists which precludes the requested action.

1 SafetyInvestigationReportReasonType

Definition:

Description: Possible reasons generating a report providing information developed during the investigation of an adverse event or a product problem.

Examples:

  • Correction
  • Additional information/Follow-up
  • Response to regulatory agency request
1 SubstanceAdminSubstitutionNotAllowedReason
 SubstanceAdminSubstitutionNotAllowedReason (C1 as CWE)

Definition:

Reasons why substitution of a substance administration request is not permitted.

1 SubstanceAdminSubstitutionReason
 SubstanceAdminSubstitutionReason (R1 as CWE)

Definition:

Indicates the reason for substitution when substitution occurs, or reason for non-substitution when substitution is expected.

2 . . SubstanceAdministrationNoSubstitutionReason

Definition:

Indicates the reason for non-substitution when substitution was expected.

Examples:

  • prescriber request
  • patient request
  • continuing therapy (where this latter means that the prescribed item was not substituted, even though "policy" implied it should be, so as not to change from the item that the patient had previously received)
2 . . SubstanceAdministrationPerformedSubstitutionReason

Definition:

Indicates the reason for substitution when substitution has occurred.

Examples:

  • formulary policy
  • regulatory requirement
  • out of stock (where this latter means that the prescribed item was out of stock and an equivalent product was substituted)
1 UpdateRefusalReasonCode
 UpdateRefusalReasonCode (R1 as CWE)

Definition:

Description: Identifies why a request to update to a record is being refused. Examples include the receiving system not able to match the identifier and find that record in the receiving system, having no permission, or a detected issue exists which precludes the requested action.


Return to concept domain index
ActRelationshipCheckpoint     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActRelationshipCheckpoint
 ActRelationshipCheckpoint (UV as CNE)
ActRelationship .checkpointCode (CS)

Definition:

A code specifying when in the course of an Act a precondition for the Act is evaluated (e.g., before the Act starts for the first time, before every repetition, after each repetition but not before the first, or throughout the entire time of the Act.)

Discussion: This attribute is part of the workflow control suite of attributes. An action plan is a composite Act with component Acts. In a sequential plan, each component has a sequenceNumber that specifies the ordering of the plan steps. Before each step is executed and has preconditions these conditions are tested and if the test is positive, the Act has clearance for execution. The repeatNumber may indicate that an Act may be repeatedly executed. The checkpointCode is specifies when the precondition is checked and is analogous to the various conditional statements and loop constructs in programming languages "while-do" vs. "do-while" or "repeat-until" vs. "loop-exit".

For all checkpointCodes, except "end", preconditions are being checked at the time when the preceding step of the plan has terminated and this step would be next in the sequence established by the sequenceNumber attribute.

When the checkpointCode for a criterion of a repeatable Act is "end", the criterion is tested only at the end of each repetition of that Act. When the condition holds true, the next repetition is ready for execution.

When the checkpointCode is "entry" the criterion is checked at the beginning of each repetition (if any) whereas "beginning" means the criterion is checked only once before the repetition "loop" starts.

The checkpointCode "through" is special in that it requires the condition to hold throughout the execution of the Act, even throughout a single execution. As soon as the condition turns false, the Act should receive an interrupt event (see interruptibleInd) and will eventually terminate.

The checkpointCode "exit" is only used on a special plan step that represents a loop exit step. This allows an action plan to exit due to a condition tested inside the execution of this plan. Such exit criteria are sequenced with the other plan components using the ActRelationship.sequenceNumber.


Return to concept domain index
ActRelationshipJoin     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActRelationshipJoin
 ActRelationshipJoin (UV as CNE)
ActRelationship .joinCode (CS)

Definition:

A code specifying how concurrent Acts are resynchronized in a parallel branch construct.

Discussion: This attribute is part of the workflow control suite of attributes. An action plan is a composite Act with component Acts. In a sequential plan, each component has a sequenceNumber that specifies the ordering of the plan steps. Branches exist when multiple components have the same sequenceNumber. Branches are parallel if the splitCode specifies that more than one branch can be executed at the same time. The joinCode then specifies if and how the braches are resynchronized.

The principal re-synchronization actions are (1) the control flow waits for a branch to terminate (wait-branch), (2) the branch that is not yet terminated is aborted (kill-branch), (3) the branch is not re-synchronized at all and continues in parallel (detached branch).

A kill branch is only executed if there is at least one active wait (or exclusive wait) branch. If there is no other wait branch active, a kill branch is not started at all (rather than being aborted shortly after it is started.) Since a detached branch is unrelated to all other branches, active detached branches do not protect a kill-branch from being aborted.


Return to concept domain index
ActRelationshipSplit     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActRelationshipSplit
 ActRelationshipSplit (UV as CNE)
ActRelationship .splitCode (CS)

Definition:

A code specifying how branches in an action plan are selected among other branches.

Discussion: This attribute is part of the workflow control suite of attributes. An action plan is a composite Act with component Acts. In a sequential plan, each component has a sequenceNumber that specifies the ordering of the plan steps. Branches exist when multiple components have the same sequenceNumber. The splitCode specifies whether a branch is executed exclusively (case-switch) or inclusively, i.e., in parallel with other branches.

In addition to exlusive and inclusive split the splitCode specifies how the pre-condition (also known as "guard conditions" on the branch) are evaluated. A guard condition may be evaluated once when the branching step is entered and if the conditions do not hold at that time, the branch is abandoned. Conversely execution of a branch may wait until the guard condition turns true.

In exclusive wait branches, the first branch whose guard conditions turn true will be executed and all other branches abandoned. In inclusive wait branches some branches may already be executed while other branches still wait for their guard conditions to turn true.


Return to concept domain index
ActRelationshipSubset     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActRelationshipSubset
 ActRelationshipSubset (UV as CNE)
ActRelationship .subsetCode (CS)

Definition:

Used to indicate that the target of the relationship will be a filtered subset of the total related set of targets.

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.

1 ParticipationSubset
 ParticipationSubset (UV as CNE)
Participation .subsetCode (CS)

Definition:

Used to indicate that the participation is a filtered subset of the total participations of the same type owned by the Act.

Used when there is a need to limit the participations to the first, the last, the next or some other filtered subset.


Return to concept domain index
ActRelationshipType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActRelationshipType
 ActRelationshipType (UV as CNE)
ActRelationship .typeCode (CS)
ActRelationship .blockedContextActRelationshipType (DSET<CS>)

Definition:

A code specifying the meaning and purpose of every ActRelationship instance. Each of its values implies specific constraints to what kinds of Act objects can be related and in which way.

Discussion: The types of act relationships fall under one of 5 categories:

1.) (De)-composition, with composite (source) and component (target)

2.) Sequel which includes follow-up, fulfillment, instantiation, replacement, transformation, etc. that all have in common that source and target are Acts of essentially the same kind but with variances in mood and other attributes, and where the target exists before the source and the source refers to the target that it links back to.

3.) Pre-condition, trigger, reason, contraindication, with the conditioned Act at the source and the condition or reason at the target.

4.) Post-condition, outcome, goal and risk, with the Act at the source having the outcome or goal at the target.

5.) A host of functional relationships including support, cause, derivation, etc. generalized under the notion of "pertinence".

1 ActRelationshipEntry
 x_ActRelationshipEntry (C1 as CNE)

Definition:

Used to enumerate the relationships between a CDA section and its contained entries.

1 ActRelationshipEntryRelationship
 x_ActRelationshipEntryRelationship (C1 as CNE)

Definition:

Description still needed

1 ActRelationshipRelatedOrder

Definition:

Description still needed


Return to concept domain index
ActSite     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActSite Access .approachSiteCode (CD)
Access .targetSiteCode (CD)
Observation .targetSiteCode (DSET<CD>)
Procedure .approachSiteCode (DSET<CD>)
Procedure .targetSiteCode (DSET<CD>)

Definition:

An anatomical location on an organism which can be the focus of an act.

1 ActBloodDonationSite

Definition:

Description: Sites used for blood donation.

Examples:

  • arm

  • leg

  • heel

1 AnimalActSite

Definition:

An anatomical location on a non-human animal which can be the focus of an act.

1 HumanActSite

Definition:

An anatomical location on a human which can be the focus of an act.

2 . . HumanSubstanceAdministrationSite
. .   HumanSubstanceAdministrationSite (C1 as CWE)

Definition:

Description: The set of body locations to or through which a substance or product may be administered.

Examples:
  • buttock
  • left upper arm
  • bilateral eyes
2 . . InjuryActSite

Definition:

An anatomical location on a human of an injury or disease which is the focus of an act.


Return to concept domain index
ActStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActStatus
 ActStatus (UV as CNE)
Act .statusCode (CS)

Definition:

Concepts representing the states in the state-machine of the RIM Act class.


Return to concept domain index
ActUncertainty     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ActUncertainty
 ActUncertainty (R1 as CWE)
Act .uncertaintyCode (CD)
ActRelationship .uncertaintyCode (CD)

Definition:

A code indicating whether the Act statement as a whole, with its subordinate components has been asserted to be uncertain in any way.

Examples: Patient might have had a cholecystectomy procedure in the past (but isn't sure).

Constraints: Uncertainty asserted using this attribute applies to the combined meaning of the Act statement established by all descriptive attributes (e.g., Act.code, Act.effectiveTime, Observation.value, SubstanceAdministration.doseQuantity, etc.), and the meanings of any components.

Discussion:This is not intended for use to replace or compete with uncertainty associated with a Observation.values alone or other individual attributes of the class. Such pointed indications of uncertainty should be specified by applying the PPD, UVP or UVN data type extensions to the specific attribute. Particularly if the uncertainty is uncertainty of a quantitative measurement value, this must still be represented by a PPD<PQ> in the value and NOT using the uncertaintyCode. Also, when differential diagnoses are enumerated or weighed for probability, the UVP<CD> or UVN<CD> must be used, not the uncertaintyCode. The use of the uncertaintyCode is appropriate only if the entirety of the Act and its dependent Acts is questioned.

Note that very vague uncertainty may be thought related to negationInd, however, the two concepts are really independent. One may be very uncertain about an event, but that does not mean that one is certain about the negation of the event.


Return to concept domain index
AddressPartType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AddressPartType
 AddressPartType (UV as CNE)

Definition:

Discussion: The hierarchical nature of these concepts shows composition. E.g. "Street Name" is part of "Street Address Line"


Return to concept domain index
AdministrativeGender     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AdministrativeGender
 AdministrativeGender (R1 as CWE)
LivingSubject .administrativeGenderCode (CD)

Definition:

The gender of a person used for adminstrative purposes (as opposed to clinical gender)


Return to concept domain index
AttentionKeyword     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AttentionKeyword AttentionLine .keyWordText (SC.NT)

Definition:

Provides coded key words for attribute AttentionLine.keyWordText, which has data type SC.


Return to concept domain index
AttentionLineValue     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 AttentionLineValue AttentionLine .value (ANY)

Definition:

Definition:The domain of possible values used as the value of attention line specifications in AttentionLine directives.


Return to concept domain index
BatchName     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 BatchName Batch .name (SC.NT)

Definition:

Provides coded names for attribute Batch.name, which has data type SC.


Return to concept domain index
Calendar     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Calendar
 Calendar (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
CalendarCycle     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 CalendarCycle
 CalendarCycle (UV as CNE)

Definition:

OpenIssue:

1 CalendarCycleOneLetter
 CalendarCycleOneLetter (UV as CNE)

Definition:

One letter calendar cycle abbreviations (Temporary - remove when RoseTree is fixed)

1 CalendarCycleTwoLetter
 CalendarCycleTwoLetter (UV as CNE)

Definition:

Two letter calendar cycle abbreviations (Temporary - remove when RoseTree is fixed)


Return to concept domain index
CalendarType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 CalendarType
 CalendarType (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
CaseDetectionMethod     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 CaseDetectionMethod PublicHealthCase .detectionMethodCode (CD)

Definition:

Code for the method by which the public health department was made aware of the case. Includes provider report, patient self-referral, laboratory report, case or outbreak investigation, contact investigation, active surveillance, routine physical, prenatal testing, perinatal testing, prison entry screening, occupational disease surveillance, medical record review, etc.


Return to concept domain index
Charset     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Charset
 Charset (UV as CNE)

Definition:

Internet Assigned Numbers Authority (IANA) Charset Types


Return to concept domain index
CodingRationale     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 CodingRationale
 CodingRationale (UV as CNE)

Definition:

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.


Return to concept domain index
CommunicationFunctionType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 CommunicationFunctionType
 CommunicationFunctionType (UV as CNE)
CommunicationFunction .typeCode (CS)

Definition:

Describes the type of communication function that the associated entity plays in the associated transmission.


Return to concept domain index
CompliancePackageEntityType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 CompliancePackageEntityType
 CompliancePackageEntityType (R1 as CWE)

Definition:

Definition:A container intended to contain sufficient material for more than one use, but grouped or organized to provide individual access to sufficient material for a single use. Often used to ensure that the proper type and amount of material is consumed/expended for each use.


Return to concept domain index
CompressionAlgorithm     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 CompressionAlgorithm
 CompressionAlgorithm (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
Confidentiality     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Confidentiality
 Confidentiality (R1 as CWE)
Act .confidentialityCode (CD)
Role .confidentialityCode (CD)

Definition:


Return to concept domain index
ContainerCap     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ContainerCap
 ContainerCap (R1 as CWE)
Container .capTypeCode (CD)

Definition:

The type of cap associated with a container


Return to concept domain index
ContainerSeparator     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ContainerSeparator
 ContainerSeparator (R1 as CWE)
Container .separatorTypeCode (CD)

Definition:

A material in a blood collection container that facilites the separation of of blood cells from serum or plasma


Return to concept domain index
ContentProcessingMode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ContentProcessingMode
 ContentProcessingMode (R1 as CWE)
Batch .contentProcessingModeCode (CD)

Definition:

Description:Identifies the order in which content should be processed.


Return to concept domain index
ContextConductionStyle     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ContextConductionStyle
 ContextConductionStyle (UV as CWE)

Definition:


Return to concept domain index
ContextControl     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ContextControl
 ContextControl (UV as CNE)
ActRelationship .contextControlCode (CS)
Participation .contextControlCode (CS)

Definition:

Identifies the control codes that are used to manage the propagation and scope of a particular ActRelationship or Participation within a set of Acts.


Return to concept domain index
Country     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Country
 Country (R1 as CWE)

Definition:

Countries of the world. ISO 3166, part 1, alpha-3 set.


Return to concept domain index
Currency     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Currency
 Currency (UV as CNE)
Account .currencyCode (CD)

Definition:

The currency unit as defined in ISO 4217


Return to concept domain index
DeviceAlertLevel     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 DeviceAlertLevel
 DeviceAlertLevel (R1 as CWE)
Device .alertLevelCode (CD)

Definition:

Domain values for the Device.Alert_levelCode


Return to concept domain index
DocumentCompletion     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 DocumentCompletion
 DocumentCompletion (R1 as CWE)
Document .completionCode (CD)

Definition:

Identifies the current completion state of a clinical document.


Return to concept domain index
DocumentStorage     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 DocumentStorage
 DocumentStorage (R1 as CWE)
Document .storageCode (CD)

Definition:

Identifies the storage status of a document.


Return to concept domain index
EducationLevel     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EducationLevel
 EducationLevel (R1 as CWE)
 EducationLevel (US as CWE)
Person .educationLevelCode (CD)

Definition:

Description: Highest level of education a person has achieved.

Examples:

  • Elementary School
  • College or baccalaureate degree complete
  • High School
Rationale:

Return to concept domain index
ElementName     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ElementName SortControl .elementName (SC.NT)

Definition:

Provides coded names for attribute SortControl.elementName , which has data type SC.


Return to concept domain index
EmployeeJob     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EmployeeJob Employee .jobCode (CD)

Definition:

A code specifying the job performed by the employee for the employer. For example, accountant, programmer analyst, patient care associate, staff nurse, etc.


Return to concept domain index
EmployeeJobClass     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EmployeeJobClass
 EmployeeJobClass (X1 as CWE)
Employee .jobClassCode (CD)

Definition:

A code qualifying the employment in various ways, such as, full-time vs. part time, etc.

1 EmployeeOccupationCode Employee .occupationCode (CD)

Definition:

Industry and/or jurisdictional classification system for kind-of-work performed by an employee.

Occupation codes are intended primarily as work descriptions that are suitable for a multitude of public uses e.g., job matching, employment counseling, occupational and career guidance, and labor market information services.


Return to concept domain index
EmployeeSalaryType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EmployeeSalaryType Employee .salaryTypeCode (CD)

Definition:

A value representing the method used by an employer to compute an employee's salary or wages.

Examples: Hourly, annual, commission


Return to concept domain index
EmploymentStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EmploymentStatus
 EmploymentStatusUB92 (US as CWE)

Definition:

A code used to define the employment status of the insured individual identified in UB-92 FL 58. UB-92 Form locator 64:Employment Status Code of the Insured. Can be used with Employee_Employer_statusCode in HL7. Values include Employed Full Time, Employed Part Time, Not Employed, Retired, On Active Military Duty


Return to concept domain index
EncounterAcuity     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EncounterAcuity

Definition:

A code depicting the acuity (complexity of patient care, resource intensiveness of the patient care) of a patient's medical condition upon arrival. Values may be derived from formal acuity coding schemes such as RBS.


Return to concept domain index
EncounterAdmissionSource     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EncounterAdmissionSource
 EncounterAdmissionSource (X1 as CWE)

Definition:

OpenIssue:


Return to concept domain index
EncounterDischargeDisposition     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EncounterDischargeDisposition
 USEncounterDischargeDisposition (US as CWE)
PatientEncounter .dischargeDispositionCode (CD)

Definition:

A code indicating patient status as of the ending service date of the period covered on this bill, as reported in FL6, Statement Covers Period. Values such as: Discharged to home or self care; Discharged/transferred to SNF, Discharged/transferred to an intermediate care facility (ICF); Expired; Hospice-medical facility. NUBC Form Locator 22


Return to concept domain index
EncounterReferralSource     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EncounterReferralSource
 USEncounterReferralSource (US as CWE)
PatientEncounter .admissionReferralSourceCode (CD)

Definition:

A code used to define the place or organization responsible for the patient immediately prior to their admission; for example, in the United States, as this is identified in UB-92 Form Locator 20, Source of Adm(ission).


Return to concept domain index
EncounterSpecialCourtesy     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EncounterSpecialCourtesy
 EncounterSpecialCourtesy (R1 as CWE)
PatientEncounter .specialCourtesiesCode (DSET<CD>)

Definition:

A code identifying special courtesies extended to the patient. For example, no courtesies, extended courtesies, professional courtesy, VIP courtesies.


Return to concept domain index
EntityClass     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityClass
 EntityClass (UV as CNE)
Entity .classCode (CS)

Definition:

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 encoded in Entity.code and are drawn from multiple, frequently external, domains that reflect much more fine-grained typing.


Return to concept domain index
EntityCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityCode
 EntityCode (C1 as CWE)
Entity .code (CD)

Definition:

A value representing the specific kind of Entity the instance represents.

Examples: A medical building, a Doberman Pinscher, a blood collection tube, a tissue biopsy.

Rationale: For each Entity, the value for this attribute is drawn from one of several coding systems depending on the Entity classCode, such as living subjects (animal and plant taxonomies), chemical substance (e.g., IUPAC code), organizations, insurance company, government agency, hospital, park, lake, syringe, etc. It is possible that Entity.code may be so fine grained that it represents a single instance. An example is the CDC vaccine manufacturer code, modeled as a concept vocabulary, when in fact each concept refers to a single instance.

1 LivingSubjectEntityType

Definition:

Anything that essentially has the property of life, independent of current state (a dead human corpse is still essentially a living subject).

Examples: persons, animals, trees .

Property:   ConceptualSpaceForClassCode: EntityClass.LIV

2 . . NonPersonLivingSubjectEntityType

Definition:

Description:Types of NonPersonLivingSubjects for the EntityClass "NLIV"

Property:   ConceptualSpaceForClassCode: EntityClass.NLIV

3 . . . AnimalEntityType

Definition:

Description: A categorizing and grouping mechanism for different types of animal in order to support treatment and reporting. The categories are expected to correspond to a single animal species, or to a related group of species.

Examples:

  • Dog

  • Reptile

  • Deer

Property:   ConceptualSpaceForClassCode: EntityClass.ANM

1 MaterialEntityClassType
 MaterialEntityClassType (C1 as CWE)

Definition:

Types of Material for EntityClass "MAT"

Property:   ConceptualSpaceForClassCode: EntityClass.MAT

2 . . ContainerEntityType
. .   ContainerEntityType (R1 as CWE)

Definition:

Definition:An object used to hold other entities.

Examples:

  • Test tube

  • Shoe box

  • Drinking glass

Property:   ConceptualSpaceForClassCode: EntityClass.CONT

3 . . . HolderEntityType

Definition:

Description: Holders are containers that hold other containers or holders.

Examples:

  • Tube rack

  • Specimen carrier

  • Tray

Property:   ConceptualSpaceForClassCode: EntityClass.HOLD

2 . . DeviceGenericType

Definition:

Includes the set of codes used to identify a device that may be referred to in an ICSR report. Example code set reference is the FDA Center for Devices and Radiological Health product code list.

Example product codes include: FOZ = Catheter, Intravascular, Therapeutic, short-term less than 30 days, MOP = Rotator, Prosthetic Heart Valve.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

2 . . DrugEntity

Definition:

A substance whose therapeutic effect is produced by chemical action within the body.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . ClinicalDrug

Definition:

Any substance or mixture of substances manufactured, sold or represented for use in: (a) the diagnosis, treatment, mitigation or prevention of a disease, disorder, abnormal physical state, or its symptoms, in human beings or animals; (b) restoring, correcting or modifying organic functions in human beings or animals.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . ActiveIngredientDrugEntityType

Definition:

Any substance which, when combined with other ingredients, delivers all or part of the therapeutic benefit associated with a medication.

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

4 . . . . ActiveMoitySubstanceType

Definition:

A molecular structure (molecule or part of a molecule) which is the part of the molecule causing the intended pharmacological action. The value set for ActiveMoietySubstanceType may often be a subset of a SubstanceType value set. Candidate value sets are subsets of ChEBI, PubChem CID, CAS Number, InChi Key, and UNII.

Examples:

  • Metoprolol (without the succinate or tartrate)

  • Amoxicillin (anhydrous)

  • Heparin (ion, without the matching Na or K cation)

Property:   ConceptualSpaceForClassCode: EntityClass.MMAT

4 . . . . ManufacturedDrug

Definition:

Identifies a drug or the use of a drug as produced by a specific manufacturer

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

5 . . . . . PackagedDrugProductEntity

Definition:

A drug product identified at the level of the package in which it is commonly distributed. Code systems such as UPC (Universal Product Code), NDC (National Drug Code), GTIN(Global Trade Item Number) might be bound to this domain in a given realm.

2 . . ExposureAgentEntityType

Definition:

Indicates the material to which the patient was exposed which is believed to be related to the adverse reaction

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . NonDrugAgentEntity
. . .   NonDrugAgentEntity (C1 as CWE)

Definition:

Indicates types of allergy and intolerance agents which are non-drugs. (E.g. foods, latex, etc.)

2 . . ManufacturedMaterialEntityType

Definition:

An Entity or combination of Entities transformed for a particular purpose by a manufacturing process.

Examples: Processed food products, disposable syringes, chemistry analyzer, saline for infusion

Property:   ConceptualSpaceForClassCode: EntityClass.MMAT

3 . . . EntityDeviceType

Definition:

A type of manufactured material used in an activity, without being substantially changed through that activity.

Property:   ConceptualSpaceForClassCode: EntityClass.DEV

4 . . . . EntityDeviceTrackingTagType

Definition:

Description:

Examples:

  • RFID
  • WiFi
  • Infrared

Property:   ConceptualSpaceForClassCode: EntityClass.DEV

3 . . . MaskableMaterialEntityType

Definition:

Description: Indicates the types of products whose associated records are allowed to be masked.

Property:   ConceptualSpaceForClassCode: EntityClass.MMAT

2 . . MicroorganismEntityType

Definition:

Description:To be used to identify a microorganism when required by an act.

Examples:

  • Escherichia coli
  • Caulimoviridae
  • Pseudomonas aeruginosa
2 . . NutritionalMaterialType

Definition:

A material that is used to provide nutritional value.

Examples:

  • Food
  • Formula
  • Supplements
3 . . . FoodType

Definition:

Concepts that are used to identify an entity that is ingested for nutritional purposes.

Examples:

  • Orange
  • Meat
  • Milk
4 . . . . NutritionalFormulaType

Definition:

Concepts that identify a type of liquid food.

Examples:

  • Milk-based
  • Fiber-Containing
  • Polymeric
4 . . . . NutritionalSupplementType

Definition:

Concepts that identify a type of nutritional supplement.

Examples:

  • Weight Loss
  • Enzyme
  • Herbal
3 . . . NutrientType

Definition:

Concepts that identify a source of nourishment.

Examples:

  • Calcium
  • Carbohydrates
  • Protein
2 . . PackagedProductEntityType

Definition:

Description: Identifies products such as (1) the GS1 (was UPC and EAN); (2) the U.S., the National Drug Code, which is the U.S. version of what is internationally named the (3) "Medicinal Product Identifier" (MPID). For device products such product code is also known as the "Unique Device Identifier" and may or may not use the GS1 system of product codes. In local contexts the product code can come from local coding systems also, as long as it is a code that denotes to a description of a manufactured product.

Examples:

  • 0049-3980-41 (NDC for Geodon Roerig 80 mg capsules 10 capsules x 8 blister packs in a carton)

Property:   ConceptualSpaceForClassCode: EntityClass.MMAT

2 . . ProductEntityType

Definition:

An identifying data string for healthcare products.

Example code sets include Healthcare Common Procedure Coding System (HCPCS) and Universal Product Code (UPC).

Property:   ConceptualSpaceForClassCode: EntityClass.MMAT

3 . . . MedicalDeviceType
. . .   MedicalDevice (R1 as CWE)

Definition:

Definition:A device with direct or indirect therapeutic purpose.

Property:   ConceptualSpaceForClassCode: EntityClass.DEV

2 . . ProductIngredientSubstanceEntityType

Definition:

Description: A type of substance that is used as an ingredient within a product.

Examples:

  • Morphine

  • wheat germ

  • calcium

Property:   ConceptualSpaceForClassCode: EntityClass.MMAT

2 . . SpecimenAdditiveEntityType
. .   SpecimenAdditiveEntity (R1 as CWE)

Definition:

Definition:Materials introduced to a specimen. These additives may be introduced in order to preserve, maintain or enhance the particular nature or component of the specimen.

Examples:

  • Ammonium heparin

  • Boric Acid

  • Phenol

Property:   ConceptualSpaceForClassCode: EntityClass.MAT

2 . . SpecimenEntityType
. .   SpecimenEntityType (X1 as CWE)

Definition:

Description: A specimen is defined as a physical entity that is an individual, a group, an item, or a part representative of a larger group, class or whole that is the target of an observation or analysis for the purpose of drawing conclusions about the group, class, or whole. This can be used to code a component of the specimen that the observation diagnosis relates to. Note that any physical entity in the universe has the potential to become a specimen.

Examples:

  • Blood

  • Water

  • Animal cadaver

Property:   ConceptualSpaceForClassCode: EntityClass.ENT

3 . . . HumanLabSpecimenEntityType

Definition:

Description: To be used to code the anatomic component of the human-sourced specimen that the lab observation relates to.

Examples:

  • Endometrial biopsy

  • Thyroid fine needle aspirate

  • Urine

Property:   ConceptualSpaceForClassCode: EntityClass.ENT

3 . . . ManufacturedMaterialSpecimenEntityType

Definition:

Description: A specimen that is manufactured or a specimen from a manufactured material. This may be a quality control specimen or a manufactured substance.

Examples:

  • Quality control specimen

  • Aspirin

  • Breakfast sausage

Property:   ConceptualSpaceForClassCode: EntityClass.MMAT

2 . . VaccineType
. .   VaccineType (C1 as CWE)

Definition:

1 OrganizationEntityType

Definition:

Further classifies entities of EntityClass ORG.

Examples:

  • HL7 workgroup

  • corporation

  • fraternal organization

Property:   ConceptualSpaceForClassCode: EntityClass.ORG

2 . . IndividualCaseSafetyReportSenderType

Definition:

A code that is used to indicate the type of organization which is originating and sending the ICSR. The current code example reference is from the International Conference on Harmonisation (ICH) Expert Workgroup guideline on Clinical Safety Data Management: Data Elements for Transmission of Individual Case Safety Reports.

Example concepts are: Pharmaceutical Company, Regulatory Authority, Health Professional, Regional Pharmacovigilence Center, World Health Organization Collaborating Center for International Drug Monitoring.

Property:   ConceptualSpaceForClassCode: EntityClass.ORG

2 . . VaccineManufacturer
. .   VaccineManufacturer (X1 as CWE)

Definition:

The manufacturer of a vaccine.

Property:   ConceptualSpaceForClassCode: EntityClass.ORG

1 PlaceEntityType

Definition:

A physical 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.

Examples: dam; city; state.

Property:   ConceptualSpaceForClassCode: EntityClass.PLC

2 . . NationEntityType
. .   NationEntityType (C1 as CWE)

Definition:

Codes identifying nation states. Allows for finer grained specification of Entity with classcode <= NAT

Example:ISO3166 country codes.

Property:   ConceptualSpaceForClassCode: EntityClass.COUNTRY

2 . . TerritoryEntityType

Definition:

Description: A territorial entity that may be cited as the body over which an agency exercises jurisdiction, or which defines a sphere in which a party has a particular responsibility.

Examples:

  • United States

  • New York

  • European Union

Property:   ConceptualSpaceForClassCode: EntityClass.PLC

1 ResourceGroupEntityType
 ResourceGroupEntityType (C1 as CWE)

Definition:

Codes to characterize a Resource Group using categories that typify its membership and/or function

.

Example: PractitionerGroup

Property:   ConceptualSpaceForClassCode: EntityClass.RGRP


Return to concept domain index
EntityDeterminer     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityDeterminer
 EntityDeterminer (UV as CNE)
Entity .determinerCode (CS)

Definition:

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.


Return to concept domain index
EntityHandling     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityHandling
 EntityHandling (R1 as CWE)
Entity .handlingCode (DSET<CD>)

Definition:

Special handling requirements for an Entity.

Example:Keep at room temperature; Keep frozen below 0 C; Keep in a dry environment; Keep upright, do not turn upside down.


Return to concept domain index
EntityNamePartQualifier     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityNamePartQualifier
 EntityNamePartQualifier (UV as CNE)

Definition:

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.


Return to concept domain index
EntityNamePartQualifierR2     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityNamePartQualifierR2
 EntityNamePartQualifierR2 (UV as CWE)

Definition:

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.


Return to concept domain index
EntityNamePartType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityNamePartType
 EntityNamePartType (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
EntityNamePartTypeR2     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityNamePartTypeR2
 EntityNamePartTypeR2 (UV as CWE)

Definition:

Description:Indicates whether the name part is a given name, family name, prefix, suffix, etc.


Return to concept domain index
EntityNameUse     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityNameUse
 EntityNameUse (UV as CNE)

Definition:

OpenIssue:

1 EntityNameSearchUse

Definition:

A name intended for use in searching or matching


Return to concept domain index
EntityNameUseR2     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityNameUseR2
 EntityNameUseR2 (UV as CWE)

Definition:

Description:A set of codes advising a system or user which name in a set of names to select for a given purpose.


Return to concept domain index
EntityRisk     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityRisk
 EntityRisk (R1 as CWE)
Entity .riskCode (DSET<CD>)

Definition:

Description:Risk associated with the handling of the material.


Return to concept domain index
EntityStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EntityStatus
 EntityStatus (UV as CNE)
Entity .statusCode (CS)

Definition:

The status of an instance of the RIM Entity class.


Return to concept domain index
EquipmentAlertLevel     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 EquipmentAlertLevel
 EquipmentAlertLevel (R1 as CWE)

Definition:

OpenIssue:


Return to concept domain index
Ethnicity     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Ethnicity
 Ethnicity (R1 as CWE)
Person .ethnicGroupCode (DSET<CD>)

Definition:

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.

OpenIssue: This concept domain definition does not align with current vocabulary practices and is much too US-centric to be appropriate as a "universal" domain.


Return to concept domain index
ExposureMode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ExposureMode
 ExposureMode (X1 as CWE)
Exposure .exposureModeCode (CD)

Definition:

Code for the mechanism by which the exposure agent was exchanged or potentially exchanged by the participants involved in the exposure.


Return to concept domain index
GenderStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 GenderStatus
 GenderStatus (R1 as CWE)
NonPersonLivingSubject .genderStatusCode (CD)

Definition:

A value representing whether the primary reproductive organs of NonPersonLivingSubject are present.


Return to concept domain index
GTSAbbreviation     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 GTSAbbreviation
 GTSAbbreviation (UV as CWE)

Definition:

OpenIssue:


Return to concept domain index
HL7ITSVersionCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 HL7ITSVersionCode
 HL7ITSVersionCode (UV as CWE)

Definition:

HL7 implementation technology specification versions. These codes will document the ITS type and version for message encoding. The code will appear in the instances based upon rules expressed in the ITS, and do not appear in the abstract message, either as it is presented to received from the ITS.


Return to concept domain index
HL7StandardVersionCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 HL7StandardVersionCode
 HL7StandardVersionCode (UV as CNE)
Transmission .versionCode (CS)

Definition:

This is the domain of HL7 version codes for the Version 3 standards. Values are to be determined by HL7 and added with each new version of the HL7 Standard.


Return to concept domain index
HL7UpdateMode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 HL7UpdateMode
 HL7UpdateMode (UV as CNE)

Definition:

The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.

Open Issue: From April 2008 harmonization: "Definition needs to be modified. Make contents to HL7 content mode code system match contents in this table" Clear that this needs to be revisited.


Return to concept domain index
HtmlLinkType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 HtmlLinkType
 HtmlLinkType (C1 as CWE)

Definition:

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


Return to concept domain index
IdentifierReliability     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 IdentifierReliability
 IdentifierReliability (UV as CNE)

Definition:

Description: The identifier was issued by the system responsible for constructing the instance.


Return to concept domain index
IdentifierScope     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 IdentifierScope
 IdentifierScope (UV as CNE)

Definition:

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.


Return to concept domain index
IndustryClassificationSystem     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 IndustryClassificationSystem
 IndustryClassificationSystem (R1 as CWE)

Definition:

North American Industry Classification System(NAICS) for the United States, a new economic classification system that replaces the 1987 Standard Industrial Classification (SIC) for statistical purposes. NAICS is a system for classifying establishments by type of economic activity. Its purposes are: (1) to facilitate the collection, tabulation, presentation, and analysis of data relating to establishments, and (2) to promote uniformity and comparability in the presentation of statistical data describing the economy. NAICS will be used by Federal statistical agencies that collect or publish data by industry. http://www.census.gov/epcd/www/naicsusr.html


Return to concept domain index
IntegrityCheckAlgorithm     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 IntegrityCheckAlgorithm
 IntegrityCheckAlgorithm (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
InvoiceElementModifier     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 InvoiceElementModifier InvoiceElement .modifierCode (DSET<CD>)

Definition:

Designates a modifier to the code attribute to provide additional information about the invoice element.

Examples: Isolation allowance; After-hours service

Rationale: This is not pre-coordinated into the CD attribute because the modifier code set may not be specifically designed for use with the Act.code code set. This violates the constraint for using the 'modifier' property that the modifier code set must be defined as part of, or specifically for the base code set.


Return to concept domain index
JobTitleName     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 JobTitleName Employee .jobTitleName (SC)

Definition:

Provides coded names for attribute Employee.jobTitleName, which has data type SC.


Return to concept domain index
LanguageAbilityMode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 LanguageAbilityMode
 LanguageAbilityMode (R1 as CWE)
LanguageCommunication .modeCode (CD)

Definition:

A value representing the method of expression of the language.

Example:Expressed spoken, expressed written, expressed signed, received spoken, received written, received signed.


Return to concept domain index
LanguageAbilityProficiency     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 LanguageAbilityProficiency
 LanguageAbilityProficiency (R1 as CWE)
LanguageCommunication .proficiencyLevelCode (CD)

Definition:

A value representing the level of proficiency in a language.

Example:Excellent, good, fair, poor.


Return to concept domain index
ListOwnershipLevel     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ListOwnershipLevel

Definition:

A dynamic list of individual instances of Act which reflect the needs of an individual worker, team of workers, or an organization to view roups of Acts for clinical or administrative reasons.

Discussion: The grouped Acts are related to the WorkingList via an ActRelationship of type 'COMP' component).

Examples: Problem lists, goal lists, allergy lists, to-do lists, etc.

Design note: This physical class contains but a single attribute, other than those that it inherits from Act. Use of that attribute in the design of RIM-based static models has been DEPRECATED in HL7 RIM Harmonization, effective November 2005. This action was based on ecommendations from the Patient Care Technical Committee.

As a consequence, this class will cease to be shown as a physical class in the RIM, once the attribute is retired. Nevertheless, use of this class via an Act.classCode value of 'LIST' is entirely appropriate so long as only the attibutes inherited from Act are used.


Return to concept domain index
LivingArrangement     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 LivingArrangement
 LivingArrangement (R1 as CWE)
Person .livingArrangementCode (CD)

Definition:

A code depicting the living arrangements of a person


Return to concept domain index
LivingSubjectLanguageTypes     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 LivingSubjectLanguageTypes
 HumanLanguage (R1 as CWE)

Definition:

Types of language sourced from an entity that is a living subject.

Usage Note: Intended to be used for CD or CV data types. Use HumanLanguage concept domain to convey languages represented in ED.Language or other CS data types.

1 HumanLanguage
 HumanLanguage (UV as CNE)
Act .languageCode (CD)
LanguageCommunication .languageCode (CD)

Definition:

Codes for the representation of the names of human languages.


Return to concept domain index
LocalMarkupIgnore     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 LocalMarkupIgnore
 LocalMarkupIgnore (C1 as CWE)

Definition:

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"


Return to concept domain index
LocalRemoteControlState     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 LocalRemoteControlState
 LocalRemoteControlState (R1 as CWE)
Device .localRemoteControlStateCode (CD)

Definition:

A value representing the current state of control associated with the device.

Examples: A device can either work autonomously (localRemoteControlStateCode="Local") or it can be controlled by another system (localRemoteControlStateCode="Remote").

Rationale: The control status of a device must be communicated between devices prior to remote commands being transmitted. If the device is not in "Remote" status then external commands will be ignored.


Return to concept domain index
ManagedParticipationStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ManagedParticipationStatus
 ManagedParticipationStatus (UV as CNE)
ManagedParticipation .statusCode (CS)

Definition:

The status of an instance of the RIM Participation class.


Return to concept domain index
ManufacturerModelName     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ManufacturerModelName Device .manufacturerModelName (SC)

Definition:

Provides coded names for attribute Device.manufacturerModelName, which has data type SC.


Return to concept domain index
MapRelationship     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 MapRelationship
 MapRelationship (C1 as CWE)

Definition:

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


Return to concept domain index
MaritalStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 MaritalStatus
 MaritalStatus (C1 as CWE)
[2.16.840.1.113883.1.11.15929]
Person .maritalStatusCode (CD)

Definition:

The domestic partnership status of a person.

Example:Married, separated, divorced, widowed, common-law marriage.


Return to concept domain index
MaterialForm     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 MaterialForm
 materialForm (C1 as CWE)
Material .formCode (CD)

Definition:

This identifies the physical state, nature or manifestation of the material.

Usage Notes: When the Material class is specialised to Manufactured Material, which it is to routinely to describe Medicinal products and ingredient Substances, and to Containers and Devices, the Material Form attribute is used more explicitly to describe the form and manifestation of these types of concepts - for example for medicinal products, the formCode describes their dose form (tablet, ointment); and for containers, it is their physical type (box, carton, vial).

Examples:

  • Powder
  • Liquid
  • Gas
1 ContainerForm

Definition:

Describes the nature (or type) of the container.

Examples:

  • Carton
  • Bottle
  • Vial

DesignNote:The material of the container should be separately specified (e.g. the "cardboard" part of cardboard carton or the "glass" part of glass vial should be described elsewhere).

OpenIssue:This usage of material form is used in Common Product Model,but it is at variance of what has been done in Specimen where the same information is captured in the Entity.code values. These differences need further study.

1 DoseForm

Definition:

Description:The physical manifestation "entity" that contains the active and/or inactive ingredients that deliver a dose of medicine (i.e., drug). The key defining characteristics of the dose form can be the state of matter, delivery method, release characteristics, and the administration site or route for which the product is formulated. (Derived from ISO IDMP specification, and SNOMED CT).

Examples:

  • Tablet
  • Capsule
  • Oral solution
2 . . AdministrableDrugForm
. .   AdministrableDrugForm (R1 as CWE)
SubstanceAdministration .administrationUnitCode (CD)

Definition:

Description: Indicates the form in which the drug product should be administered.

This element only needs to be specified when (a) the form in which the drug is measured for dispensing differs from the form in which the drug is administered; and (b) the form in which the quantity of the administered drug being administered is not expressed as a discrete measured mass or volume, e.g. the dose is to be measured in "number of actuations."

2 . . CombinedDoseForm

Definition:

The description of this is: "Identifies, as a single concept, a combination dose form description for those products that contain two or more manufactured items in a single authorized product".

Usage Notes: This element needs only to be specified when the product entity describes a complete product that contains two or more manufactured items (sometimes called a combination product or a kit product); it should not be valued for (normal) products which consist of a single manufactured item with a single dose form. The combined dose form describes the orderable (manufactured) dose form of each manufactured item and (if appropriate, separately) the administrable dose form of the pharmaceutical product (as in example one below).

Examples:

  • Powder and solvent for solution for injection
  • Pessary and vaginal cream
  • Tablets and capsules
2 . . OrderableDrugForm
. .   OrderableDrugForm (R1 as CWE)

Definition:

Description:Indicates the form in which the drug product must be, or has been manufactured, or extemporaneous/magistral prepared .


Return to concept domain index
MediaType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 MediaType
 MediaType (UV as CNE)

Definition:

Internet Assigned Numbers Authority (IANA) Mime Media Types


Return to concept domain index
MessageWaitingPriority     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 MessageWaitingPriority
 MessageWaitingPriority (R1 as CWE)
Acknowledgement .messageWaitingPriorityCode (CD)

Definition:

Indicates the highest importance level of the set of messages the acknowledging application has waiting on a queue for the receiving application.

Discussion: These messages would need to be retrieved via a query. This facilitates receiving applications that cannot receive unsolicited messages (i.e. polling). The specific code specified identifies how important the most important waiting message is (and may govern how soon the receiving application is required to poll for the message).

Priority may be used by local agreement to determine the timeframe in which the receiving application is expected to retrieve the messages from the queue.


Return to concept domain index
ModifyIndicator     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ModifyIndicator
 ModifyIndicator (UV as CNE)
QuerySpec .modifyCode (CS)

Definition:

Indicates whether the subscription to a query is new or is being modified.


Return to concept domain index
NullFlavor     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 NullFlavor
 NullFlavor (UV as CNE)
InfrastructureRoot .nullFlavor (CS)

Definition:

Indication or reason why a valid value is not present.


Return to concept domain index
ObservationInterpretation     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ObservationInterpretation
 ObservationInterpretation (R1 as CWE)
Observation .interpretationCode (DSET<CD>)

Definition:

One or more codes specifying a rough qualitative interpretation of the observation, such as "normal", "abnormal", "below normal", "change up", "resistant", "susceptible", etc.

Discussion: These interpretation codes are sometimes called "abnormal flags", however, the judgment of normalcy is just one of the common rough interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy", and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."

1 GeneticObservationInterpretation
 GeneticObservationInterpretation (X1 as CWE)

Definition:

Concepts that specify interpretation of genetic analysis.

Examples:

  • positive
  • negative
  • carrier
  • responsive
1 ObservationInterpretationChange
 ObservationInterpretationChange (R1 as CWE)

Definition:

Interpretations of change of quantity and/or severity.

Examples:

  • better
  • worse
  • increased
1 ObservationInterpretationDetected
 ObservationInterpretationDetected (R1 as CWE)

Definition:

Interpretations of the presence or absence of a component / analyte or organism in a test or of a sign in a clinical observation. In keeping with laboratory data processing practice, this provides a categorical interpretation of the "meaning" of the quantitative value for the same observation.

1 ObservationInterpretationExceptions
 ObservationInterpretationExceptions (R1 as CWE)

Definition:

Technical exceptions resulting in the inability to provide an interpretation, such as "off scale". Does not include normality or severity.

1 ObservationInterpretationNormality
 ObservationInterpretationNormality (R1 as CWE)

Definition:

Interpretations of normality or degree of abnormality (including critical or "alert" level). Concepts in this category are mutually exclusive, i.e., at most one is allowed.

1 ObservationInterpretationSusceptibility
 ObservationInterpretationSusceptibility (R1 as CWE)

Definition:

Interpretations of anti-microbial susceptibility testing results (microbiology). At most one allowed.

1 ReactivityObservationInterpretation
 ReactivityObservationInterpretation (R1 as CWE)

Definition:

Interpretations of the presence and level of reactivity of the specified component / analyte with the reagent in the performed laboratory test.


Return to concept domain index
ObservationMethod     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ObservationMethod
 ObservationMethod (X1 as CWE)
Observation .methodCode (DSET<CD>)

Definition:

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.

Constraints: In all observations the method is already partially specified by the Act.code. In this case, the methodCode NEED NOT be used at all. The methodCode MAY still be used to identify this method more clearly in addition to what is implied from the Act.code. However, an information consumer system or process SHOULD NOT depend on this methodCode information for method detail that is implied by the Act.code.

If the methodCode is used to express method detail that is also implied by the Act.code, the methodCode MUST NOT be in conflict with the implied method of the Act.code.

Discussion: In all observations the method is already partially specified by simply knowing the kind of observation (observation definition, Act.code) and this implicit information about the method does not need to be specified in Observation.methodCode. Particularly, most LOINC codes are defined for specific methods as long as the method makes a practical difference in interpretation. For example, the difference between susceptibility studies using the "minimal inhibitory concentration" (MIC) or the "agar diffusion method" (Kirby-Baur) are specifically assigned to different LOINC codes. The methodCode therefore is only an additional qualifier to specify what may not be known already from the Act.code.

Also, some variances in methods may be tied to the particular device used. The methodCode should not be used to identify the specific device or test-kit material used in the observation. Such information about devices or test-kits should be associated with the observation as "device" participations.

1 AllergyTestObservationMethod

Definition:

Description:Provides additional methodology information not present in the associated AllergyTestCode term.

1 CommonClinicalObservationMethod

Definition:

Description:Used in a patient care message to value simple clinical (non-lab) observation methods, such as found in SOAP (subjective, objective, assessment, plan) progress notes: subjective section (used for history from patient and other informants); objective section (used for physical exam, lab, and other common results), and assessment section (used for the clinicians assessment of the implications of subjective and objective sections).

1 DecisionObservationMethod
 DecisionObservationMethod (R1 as CWE)

Definition:

Provides codes for decision methods, initially for assessing the causality of events.

1 GeneticObservationMethod
 GeneticObservationMethod (X1 as CWE)

Definition:

A code that provides additional detail about the means or technique used to ascertain the genetic analysis. Example, PCR, Micro Array.

1 SusceptibilityObservationMethodType
 SusceptibilityObservationMethodType (R1 as CWE)

Definition:

Description:

Examples:

  • Disk Diffusion (Kirby-Bauer)
  • Minimum Inhibitory Concentration
  • Viral Genotype Susceptibility
  • Gradient Strip (E-Strip)

Property:   ConceptualSpaceForClassCode: ActClass.OBS

1 VerificationMethod

Definition:

OpenIssue:


Return to concept domain index
ObservationValue     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ObservationValue Observation .value (ANY)

Definition:

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.

1 ActCoverageAssessmentObservationValue
 ActCoverageAssessmentObservationValue (C1 as CWE)

Definition:

Codes specify the category of observation, evidence, or document used to assess for services, e.g., discharge planning, or to establish eligibility for coverage under a policy or program. The type of evidence is coded as observation values.

2 . . ActFinancialStatusObservationValue
. .   ActFinancialStatusObservationValue (C1 as CWE)

Definition:

Code specifying financial indicators used to assess or establish eligibility for coverage under a policy or program; e.g., pay stub; tax or income document; asset document; living expenses.

1 AgeGroupObservationValue
 AgeGroupObservationValue (R1 as CWE)

Definition:

Observation value of a person's age group (e.g., newborn infant, child preschool, young adult).

1 AllergyTestValue
 AllergyTestValue (C1 as CWE)

Definition:

Indicates the result of a particular allergy test. E.g. Negative, Mild, Moderate, Severe

1 AnnotationValue

Definition:

OpenIssue:

2 . . ECGAnnotationValue

Definition:

OpenIssue:

1 CaseDiseaseImported PublicHealthCase .diseaseImportedCode (CD)

Definition:

Code that indicates whether the disease was likely acquired outside the jurisdiction of observation, and if so, the nature of the inter-jurisdictional relationship. Possible values include not imported, imported from another country, imported from another state, imported from another jurisdiction, and insufficient information to determine.

1 CaseTransmissionMode
 CaseTransmissionMode (R1 as CWE)
PublicHealthCase .transmissionModeCode (CD)

Definition:

Code for the mechanism by which disease was acquired by the living subject involved in the public health case. Includes sexually transmitted, airborne, bloodborne, vectorborne, foodborne, zoonotic, nosocomial, mechanical, dermal, congenital, environmental exposure, indeterminate.

OpenIssue: Consider moving this attribute to Observation.

1 CommonClinicalObservationValue

Definition:

Description:Used in a patient care message to value simple clinical (non-lab) observations.

2 . . CommonClinicalObservationAssertionValue

Definition:

Definition: The non-laboratory, non-DI (diagnostic imaging) coded observation if no value is also required to convey the full meaning of the observation. This may be a single concept code or a complex expression.

2 . . CommonClinicalObservationComponentValue

Definition:

Description: Represents observations for components of a clinical observation whose value is expressed as a code.

Examples:

  • results for individual components of an APGAR score

  • aberrant

  • ABO incompatibility reaction

2 . . CommonClinicalObservationResultValue

Definition:

Definition: The non-laboratory, non-diagnostic imaging coded result of the coded observable or "question" represented by the paired concept from the the NonLabDICodedObservationType domain.

]

Examples:An APGAR result, a functional assessment, etc. The value must not require a specific unit of measure.

1 CoverageChemicalDependencyValue

Definition:

Definition: The category of addiction used for coverage purposes that may refer to a substance, the consumption of which may result in physical or emotional harm.

1 CoverageLimitObservationValue
 CoverageLimitObservationValue (R1 as CWE)

Definition:

Description:Coded observation values for coverage limitations, for e.g., types of claims or types of parties covered under a policy or program.

2 . . CoverageItemLimitObservationValue

Definition:

Description:Coded observation values for types or instances of items for which coverage is provided under a policy or program, e.g., a type of vehicle or a named work of art.

2 . . CoverageLevelObservationValue
. .   CoverageLevelObservationValue (R1 as CWE)

Definition:

Description:Coded observation values for types of covered parties under a policy or program based on their personal relationships or employment status.

2 . . CoverageLocationLimitObservationValue

Definition:

Description:Coded observation values for types or instances of locations for which coverage is provided under a policy or program, e.g., in the covered party home, in state or in the country.

1 CriticalityObservationValue

Definition:

Values that represent a clinical judgment as to the worst case result of a future occurrence or the evolution of a current occurrence.

Examples:

  • Critical
  • High
  • Low
1 CultureObservationValue

Definition:

Description:Used to code and identify the Microbiology laboratory result value when a result is reported.

Examples:

  • Gram Positive Rods
  • Epithelial Cells
  • Polymorphonuclear Leukocyte
1 Diagnosis
 DiagnosisICD9CM (US as CWE)

Definition:

Set of codes depicting clinical disease and conditions

1 FinancialClinicalSupportingObservationValue

Definition:

Description:Contains the supporting information values for financial transactions such as a Special Authorization Request.

This concept domain is intended to be used as the "value" part of a code/value pair within a generic structure that would convey any sort of information or proof of criteria that is needed to support a special authorization request. For example:

One wishes to convey a patient's DSM IV diagnosis to support a special authorization request. One code/value pair is used:

ActSupportingInformationCode1 = DSM IV Diagnosis, value= 315.4

1 GISPositionAccuracyTierCode
 SCDHEC-GISSpatialAccuracyTiers (R1 as CWE)

Definition:

Description: Categorizes the accuracy of spatial data assignment utilizing a variety of tools for capturing coordinates including digitizers, geocoding software and global positioning system devices.

1 GeneticObservationValue

Definition:

Description: The domain contains genetic analysis specific observation values, e.g. Homozygote, Heterozygote, etc.

1 IndicationValue

Definition:

Indicates the specific observation result which is the reason for the action (prescription, lab test, etc.). E.g. Headache, Ear infection, planned diagnostic image (requiring contrast agent), etc.

2 . . DiagnosisValue

Definition:

Diagnosis Value

2 . . OtherIndicationValue

Definition:

Indicates an observed reason for a medical action other than an indication or symptom. E.g. Need for a contrast agent prior to a diagnostic image, need for anesthesia prior to surgery, etc.

2 . . SymptomValue

Definition:

Indicates an observed abnormality in the patientaTMs condition, but does not assert causation. E.g. Runny nose, swelling, flaky skin, etc.

1 IndividualCaseSafetyReportValueDomains

Definition:

This domain is established as a parent to a variety of value domains being defined to support the communication of Individual Case Safety Reports to regulatory bodies. Arguably, this aggregation is not taxonomically pure, but the grouping will facilitate the management of these domains.

2 . . CaseSeriousnessCriteria

Definition:

A code that provides information on the overall effect or outcome of the adverse reaction/adverse event reported in the ICSR. Note the criterion applies to the case as a whole and not to an individual reaction.

Example concepts are: death, disability, hospitalization, congenital anomaly/ birth defect, and other medically important condition.

Property:   ConceptualSpaceForClassCode: actCode.CASESER

2 . . DeviceManufacturerEvaluationInterpretation

Definition:

A code set that includes codes that are used to characterize the outcome of the device evaluation process. The code defines the manufacturer's conclusions following the evaluation.

Examples include: inadequate alarms, device maintenance contributed to event, device failed just prior to use, user error caused event

2 . . DeviceManufacturerEvaluationMethod

Definition:

Code assigned to indicate a relevant fact within the context of the evaluation of a reported product. There are a number of concept types including the status of the evaluation, the type of evaluation findings, and the type of activity carried out as part of the evaluation process.

Examples include: Actual device involved in incident was evaluated, electrical tests performed, visual examination.

2 . . DeviceManufacturerEvaluationResult

Definition:

Code assigned to indicate an outcome of the manufacturer's investigation of a product for which a defect has been reported.

Examples include:.component/subassembly failure: air cleaner, computer-, imaging system-, microprocessor-controlled device problem: cache memory, design -- not fail safe.

2 . . PertinentReactionRelatedness

Definition:

A code to capture the reporter's assessment of the extent to which the reaction is related to the suspect product reported in the ICSR.

Example concepts include: related, not related, possibly related and unlikely related.

2 . . ProductCharacterization

Definition:

A code that characterizes the role that the primary reporter felt that the suspect intervention -- either a substance administration or a device related procedure - played in the incident being reported. This code will capture the primary reporter's assessment of the role that the suspect product played in the incident reported in the ICSR.

Examples include: Suspect, Concomitant, Interacting, Re-challenge.

2 . . SubjectReaction

Definition:

A code to capture the kind of reaction that was suffered by the investigated subject, and that is being reported in the ICSR. At this point, SNOMED or MedDRA have been suggested as code systems to be used for providing this information.

Example concepts include hives, swelling, rash, anaphylactic shock.

2 . . SubjectReactionEmphasis

Definition:

Code that captures the emphasis that the reporter placed on this reaction.

Examples include: highlighted by the reporter, NOT serious, Not highlighted by the reporter, NOT serious, Highlighted by the reporter, SERIOUS, Not highlighted by the reporter, SERIOUS.

2 . . SubjectReactionOutcome

Definition:

Code that captures the type of outcome from an individual outcome of a reaction to the suspect product reported in the ICSR.

Examples include: Recovered/resolved. Recovering/resolving, Not recovered/not resolved, Recovered/resolved with sequelae, Fatal.

1 InjuryObservationValue

Definition:

Values for observations of injuries.

1 IntoleranceValue

Definition:

Codes identifying pariticular groupings of allergens and other agents which cause allergies and intolerances. E.g. the drug, allergen group, food or environmental agent which triggers the intolerance

1 IsolateObservationValue

Definition:

Description:Used to code and identify the Isolate observation result value when a coded result is reported.

Examples:

  • Heavy growth
  • Scant growth
  • Moderate growth
1 IssueTriggerObservationValue

Definition:

The combined domain for different types of coded observation issue triggers, such as diagnoses, allergies, etc.

1 KnowledgeSubTopicObservationValue
 KnowledgeSubtopicObservationValue (R1 as CWE)

Definition:

Observation values that document the types of observations belonging to the domain KnowledgeSubTopicObservationType.

1 KnowledgeSubjectObservationValue
 KnowledgeSubjectObservationValue (R1 as CWE)

Definition:

Observation values that document the types of observations belonging to the domain KnowledgeSubjectObservationType.

1 LabResultObservationValue

Definition:

Description: Used to code and identify the laboratory result value when a coded result is reported.

Examples:

  • Sickle cell trait
  • Hereditary Spherocytosis
  • Deficiency of butyryl-CoA dehydrogenase
1 MeasureAttributeObservationValue
 MeasureAttributeObservationValue (R1 as CWE)

Definition:

Observation values used for various types of coded measure attributes in a health quality measure (eMeasure).

2 . . MeasureAttributeItemsCountedObservationValue

Definition:

Observation values used for an items counted measure attribute in a health quality measure (eMeasure).

2 . . MeasureAttributeJurisdictionObservationValue

Definition:

Observation values used for a jurisdiction measure attribute in a health quality measure (eMeasure).

Examples:

  • ISO Country codes
  • State and County codes
  • FIPS value sets of postal codes
  • districts
  • regions
2 . . MeasureAttributeReporterTypeObservationValue

Definition:

Observation values used for a reporter type measure attribute in a health quality measure (eMeasure).

Examples:

  • Laboratory
  • Healthcare Providers
  • Hospitals
  • Healthcare facilities that are NOT hospitals
  • Schools
  • Pharmacists
  • Veterinary lab
  • Veterinarian
  • Prison/Jail
  • Institutions
  • Employers
2 . . MeasureAttributeServiceDeliveryLocationObservationValue
. .   RoleClassServiceDeliveryLocation (R1 as CWE)

Definition:

Observation values used for a service delivery location measure attribute in a health quality measure (eMeasure).

2 . . ObservationMeasureScoring
. .   ObservationMeasureScoring (R1 as CWE)

Definition:

Observation values used to indicate the type of scoring (e.g. proportion, ratio) used by a health quality measure.

2 . . ObservationMeasureType
. .   ObservationMeasureType (R1 as CWE)

Definition:

Observation values used to indicate whether a health quality measure is used to sample a process or outcome over time.

1 ObservationCaseStatusValue

Definition:

Description: A code used to identify the status of a case. Used with the OBS ActClass.

Examples:

  • Suspect

  • Confirmed

  • Probable

1 ObservationCriteriaValue

Definition:

Description:Type of coded observation values in evaluating reference ranges.

Examples:

  • Surgically transgendered transsexual, female-to-male
  • AIDS-associated disorder
  • Asian race
1 ObservationOutbreakExtentValue

Definition:

Description: A code used to identify the extent of an outbreak. Used with the OBS.

Examples:

  • Local

  • Regional

  • National

1 PublicHealthCaseObservationValue

Definition:

Description: The PublicHealthCaseObservationValue is used to identify the primary condition or disease associated with a Public Health Case.. This concept domain is intended to be used with the CASE Act class code and the ObservationInvestigationType ActCode concept domain.

Examples:

  • Tuberculosis

  • Lyme Disease

  • SARS

  • Lung Cancer

2 . . OutbreakObservationValue

Definition:

Description: The OutbreakObservationValue is used to identify the primary condition or disease associated with an Outbreak. This concept domain is intended to be used with the OUTB Act class code and the ObservationPublicHealthOutbreakType ActCode concept domain.

Examples:

  • Tuberculosis

  • Lyme Disease

  • SARS

1 SecurityObservationValue
 SecurityObservationValue (R1 as CWE)

Definition:

Observation values used to indicate security observation metadata.

Examples:

  • Codes conveying the classification of an IT resource, such as confidentiality codes
  • Codes conveying privacy law, sensitivity, and consent directive types governing an IT resource
  • Codes conveying dissemination controls, handling caveats, purpose of use, refrain policies, and obligations to which an IT resource custodian or receiver must comply.
  • Codes conveying an IT resource completeness, veracity, reliability, trustworthiness, and provenance
  • Codes conveying the mechanism used to preserve the accuracy and consistency of an IT resource such as a digital signature and a cryptographic hash function
  • Codes conveying the mechanism used to make authorized alterations of an IT resource, such as translation, masking, and anonymization

Usage Note: SecurityObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityObservationType code. [FIPS 188]

2 . . SecurityCategoryObservationValue
. .   SecurityCategoryObservationValue (R1 as CWE)

Definition:

Security observation values used to indicate security category metadata.

Examples: Codes conveying the category of an IT resource such as:

  • applicable privacy policy
  • sensitivity
  • consent directive type

Usage Note: SecurityCategoryObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityCategoryObservationType code. [FIPS 188]

2 . . SecurityClassificationObservationValue

Definition:

Security observation values used to indicate security classification metadata.

Examples: Codes conveying the classification of an IT resource, such as confidentiality codes.

Usage Note: SecurityClassificationObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityClassificationObservationType code. [FIPS 188]

2 . . SecurityControlObservationValue
. .   SecurityControlObservationValue (R1 as CWE)

Definition:

Security observation values used to indicate security control metadata.

Examples: Codes conveying dissemination controls, handling caveats, purpose of use, and obligations to which an IT resource custodian or receiver must comply.

Usage Note: SecurityControlObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityControlObservationType code. [FIPS 188]

2 . . SecurityIntegrityObservationValue

Definition:

Security observation values used to indicate security integrity metadata.

Examples: Codes conveying an IT resource:

  • veracity
  • reliability
  • trustworthiness
  • provenance

Usage Note: SecurityIntegrityObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityIntegrityObservationType code. [FIPS 188]

3 . . . SecurityAlterationIntegrityObservationValue

Definition:

Security observation values used to indicate security alteration integrity metadata.

Examples: Codes conveying the mechanisms used to make authorized alteration of an IT resource, such as:

  • translation
  • masking
  • anonymization

Usage Note: SecurityAlterationIntegrityObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityAlterationIntegrityObservationType code. [FIPS 188]

3 . . . SecurityDataIntegrityObservationValue

Definition:

Security observation values used to indicate security data integrity metadata.

Examples: Codes conveying the mechanisms used to preserve the accuracy and consistency of an IT resource such as:

  • a digital signature
  • a cryptographic hash function

Usage Note: SecurityDataIntegrityObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityDataIntegrityObservationType code. [FIPS 188]

3 . . . SecurityIntegrityConfidenceObservationValue

Definition:

Security observation values used to indicate security integrity confidence metadata.

Examples: Codes conveying the level of veracity, reliability, and trustworthiness of an IT resource.

Usage Note: Codes conveying the level of veracity, reliability, and trustworthiness of an IT resource.

3 . . . SecurityIntegrityProvenanceObservationValue

Definition:

Security observation values used to indicate security alteration integrity metadata.

Examples: Codes conveying the provenance of an IT resource such as the entity responsible for a report or assertion relayed "second-hand" about an IT resource.

Usage Note: SecurityIntegrityProvenanceObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityIntegrityProvenanceObservationType code. [FIPS 188]

4 . . . . SecurityIntegrityProvenanceAssertedByObservationValue

Definition:

Security observation values used to indicate security integrity provenance asserted by metadata.

Examples: Codes conveying the provenance metadata about the entity asserting an IT resource.

Usage Note: SecurityIntegrityProvenanceAssertedByObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityIntegrityProvenanceAssertedByObservationType code. [FIPS 188]

4 . . . . SecurityIntegrityProvenanceReportedByObservationValue

Definition:

Security observation values used to indicate security integrity provenance reported by metadata.

Examples: Codes conveying the provenance metadata about the entity reporting an IT resource.

Usage Note: SecurityIntegrityProvenanceReportedByObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityIntegrityProvenanceReportedByObservationType code. [FIPS 188]

3 . . . SecurityIntegrityStatusObservationValue

Definition:

Security observation values used to indicate security integrity status metadata.

Examples: Codes conveying the completeness of an IT resource in terms of workflow status such as:

  • authenticated
  • legally authenticated
  • in progress

Usage Note: SecurityIntegrityStatusObservationValue codes are members of a security label "tag set" used to populate or "tag" a security label field named by the associated SecurityIntegrityStatusObservationType code. [FIPS 188]

1 SeverityObservationValue

Definition:

Description: An indication of the seriousness of the subject's condition or issue.

Examples:

  • Mild
  • Moderate
  • Severe
1 SusceptibilityObservationValue

Definition:

Description:Used to code and identify the Susceptibility Observation result value when a coded result is reported.

Examples:

  • Susceptible
  • Resistant
  • Moderately susceptible
1 VerificationOutcomeValue
 VerificationOutcomeValue (C1 as CWE)

Definition:

Values for observations of verification act results

Examples: Verified, not verified, verified with warning.


Return to concept domain index
OrganizationIndustryClass     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 OrganizationIndustryClass
 OrganizationIndustryClassNAICS (US as CWE)
Organization .standardIndustryClassCode (CD)

Definition:

Domain provides classification systems for industries.


Return to concept domain index
ParameterItemSemanticsType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ParameterItemSemanticsType ParameterItem .semanticsText (SC.NT)

Definition:

A code indicating the name of a parameter item. ParameterItem classes are defined in the RIM as name-value pairs and this domain provides the name part of the ParameterItem.

Examples: Patient Name, Drug Code, Order Effective Date


Return to concept domain index
ParticipationFunction     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ParticipationFunction
 ParticipationFunction (X1 as CWE)
Participation .functionCode (CD)

Definition:

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

Property:   ConceptualSpaceForClassCode: ParticipationType.PRF

1 AuthorizedParticipationFunction
 AuthorizedParticipationFunction (C1 as CWE)

Definition:

This code is used to specify the exact function an actor is authorized to have in a service in all necessary detail.

2 . . AuthorizedReceiverParticipationFunction
. .   AuthorizedReceiverParticipationFunction (C1 as CWE)

Definition:

This code is used to specify the exact function an actor is authorized to have as a receiver of information that is the subject of a consent directive or consent override.

2 . . ConsenterParticipationFunction
. .   ConsenterParticipationFunction (C1 as CWE)

Definition:

This code is used to specify the exact function an actor is authorized to have in authoring a consent directive.

2 . . OverriderParticipationFunction
. .   OverriderParticipationFunction (C1 as CWE)

Definition:

This code is used to specify the exact function an actor is authorized to have in authoring a consent override.

1 ConsultantParticipationFunction

Definition:

Description: Identifies functions appropriate to consultant participations.

Examples:

  • cardiologist

  • anesthetist

  • dietician

Property:   ConceptualSpaceForClassCode: ParticipationType.CON

1 CoverageParticipationFunction
 CoverageParticipationFunction (R1 as CWE)

Definition:

Definition: Set of codes indicating the manner in which sponsors, underwriters, and payers participate in a policy or program.

2 . . PayorParticipationFunction
. .   PayorParticipationFunction (C1 as CWE)

Definition:

Definition: Set of codes indicating the manner in which payors participate in a policy or program.</

2 . . SponsorParticipationFunction
. .   SponsorParticipationFunction (C1 as CWE)

Definition:

Definition: Set of codes indicating the manner in which sponsors participate in a policy or program. NOTE: use only when the Sponsor is not further specified with a SponsorRoleType as being either a fully insured sponsor or a self insured sponsor.

2 . . UnderwriterParticipationFunction
. .   UnderwriterParticipationFunction (C1 as CWE)

Definition:

Definition: Set of codes indicating the manner in which underwriters participate in a policy or program.

1 MolecularInteractionFunction

Definition:

Specific functiona that a participant may have in a molecular interaction.

Examples: Receptor, allosteric inhibitor, co-factor, catalyst, co-enzyme, competitive inhibitor, etc.

1 PerformerParticipationFunction

Definition:

Description: Identifies functions appropriate to performer participations.

Examples:

  • surgeon

  • lab technician

  • janitor

Property:   ConceptualSpaceForClassCode: ParticipationType.PRF


Return to concept domain index
ParticipationMode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ParticipationMode
 ParticipationMode (R1 as CWE)
Participation .modeCode (CD)

Definition:

Identifies a means by which an Entity participates in an Act.


Return to concept domain index
ParticipationSignature     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ParticipationSignature
 ParticipationSignature (R1 as CWE)
Participation .signatureCode (CD)

Definition:

A code 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.)


Return to concept domain index
ParticipationType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ParticipationType
 ParticipationType (UV as CNE)
ActRelationship .blockedContextParticipationType (DSET<CS>)
Participation .typeCode (CS)

Definition:

A code specifying the kind of Participation or involvement the Entity playing the Role associated with the Participation has with regard to the associated Act.

Constraints: The Participant.typeCode contains only categories that have crisp semantic relevance in the scope of HL7. It is a coded attribute without exceptions and no alternative coding systems allowed.


Return to concept domain index
PatientImportance     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 PatientImportance
 PatientImportance (C1 as CWE)
Patient .veryImportantPersonCode (CD)

Definition:

Patient VIP code


Return to concept domain index
PaymentTerms     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 PaymentTerms
 PaymentTerms (R1 as CWE)
FinancialContract .paymentTermsCode (CD)

Definition:

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.


Return to concept domain index
PersonDisabilityType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 PersonDisabilityType
 PersonDisabilityType (R1 as CWE)
Person .disabilityCode (DSET<CD>)

Definition:

A code identifying a person's disability.


Return to concept domain index
PostalAddressUse     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 PostalAddressUse
 PostalAddressUse (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
ProbabilityDistributionType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ProbabilityDistributionType
 ProbabilityDistributionType (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
ProcedureMethod     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ProcedureMethod Procedure .methodCode (DSET<CD>)

Definition:

Description:A concept whose description/definition provides additional detail about the means or technique used for the procedure.

Examples:

  • neuromuscular reeducation

  • functional activity

  • Laparoscopic Gastric Bypass Roux-en-Y

1 BloodDonationProcedureMethod

Definition:

Description: Specific method used to extract the blood from the donor subject.

Examples:No examples supplied with proposal.

1 EnteralAdministrationMethodType

Definition:

A concept that conveys how a material will be administered enterally.

Examples:

  • Continuous Tube Feeding
  • Gravity Drip
  • Bolus Feeding

Return to concept domain index
ProcessingID     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ProcessingID
 ProcessingID (UV as CNE)
Message .processingCode (CS)

Definition:

This attribute defines whether the message is part of a production, training, or debugging system.


Return to concept domain index
ProcessingMode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ProcessingMode
 ProcessingMode (UV as CNE)
Message .processingModeCode (CS)

Definition:

This attribute defines whether the message is being sent in current processing, archive mode, initial load mode, restore from archive mode, etc.


Return to concept domain index
QueryParameterValue     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 QueryParameterValue ParameterItem .value (ANY)

Definition:

The domain of coded values used as parameters within QueryByParameter queries.

1 IssueFilterCode

Definition:

Description:Indicates how result sets should be filtered based on whether they have associated issues.

1 PrescriptionDispenseFilterCode

Definition:

A "helper" vocabulary used to construct complex query filters based on how and whether a prescription has been dispensed.


Return to concept domain index
QueryPriority     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 QueryPriority
 QueryPriority (UV as CNE)
QuerySpec .responsePriorityCode (CS)

Definition:

Identifies the time frame in which the response is expected.


Return to concept domain index
QueryRequestLimit     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 QueryRequestLimit
 QueryRequestLimit (C1 as CWE)
QuerySpec .initialQuantityCode (CD)

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


Return to concept domain index
QueryResponse     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 QueryResponse
 QueryResponse (UV as CNE)
QueryAck .queryResponseCode (CS)

Definition:

Values in this domain allow a query response system to return a precise response status.


Return to concept domain index
QueryStatusCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 QueryStatusCode
 QueryStatusCode (UV as CNE)
QueryEvent .statusCode (CS)

Definition:

State attributes for Query event


Return to concept domain index
Race     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Race
 Race (C1 as CWE)
Person .raceCode (DSET<CD>)

Definition:

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.

OpenIssue: This concept domain definition does not align with current vocabulary practices and is much too US-centric to be appropriate as a "universal" domain.


Return to concept domain index
Realm     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Realm
 BindingRealm (UV as CNE)
InfrastructureRoot .realmCode (DSET<CS>)

Definition:

Description: All binding realms allowed for linking concept domains to value sets.


Return to concept domain index
RelationalName     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RelationalName

Definition:

Provides coded names for attribute RelationalExpression.elementName, which has data type SC.


Return to concept domain index
RelationalOperator     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RelationalOperator
 RelationalOperator (UV as CWE)

Definition:

Identifies common relational operators used in selection criteria.


Return to concept domain index
RelationshipConjunction     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RelationshipConjunction
 RelationshipConjunction (UV as CNE)
ActRelationship .conjunctionCode (CS)

Definition:

A code specifying the logical conjunction of the criteria among all the condition-links of Acts (e.g., and, or, exclusive-or.)

Constraints: All AND criteria must be true. If OR and AND criteria occur together, one criterion out of the OR-group must be true and all AND criteria must be true also. If XOR criteria occur together with OR and AND criteria, exactly one of the XOR criteria must be true, and at least one of the OR criteria and all AND criteria must be true. In other words, the sets of AND, OR, and XOR criteria are in turn combined by a logical AND operator (all AND criteria and at least one OR criterion and exactly one XOR criterion.) To overcome this ordering, Act criteria can be nested in any way necessary.


Return to concept domain index
ReligiousAffiliation     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ReligiousAffiliation
 ReligiousAffiliation (R1 as CWE)
Person .religiousAffiliationCode (CD)

Definition:

Assigment of spiritual faith affiliation


Return to concept domain index
ResponseLevel     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ResponseLevel
 ResponseLevel (UV as CNE)
Message .responseCode (CS)

Definition:

Specifies whether a response is expected from the addressee of this interaction and what level of detail that response should include


Return to concept domain index
ResponseModality     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ResponseModality
 ResponseModality (UV as CNE)
QuerySpec .responseModalityCode (CS)

Definition:

Defines the timing and grouping of the response instances.


Return to concept domain index
ResponseMode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 ResponseMode
 ResponseMode (UV as CNE)
Transmission .responseModeCode (CS)

Definition:

Specifies the mode, immediate versus deferred or queued, by which a receiver should communicate its receiver responsibilities.


Return to concept domain index
RoleClass     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RoleClass
 RoleClass (UV as CNE)
Role .classCode (CS)

Definition:

This table includes 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 be de 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.


Return to concept domain index
RoleCode     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RoleCode Role .code (CD)

Definition:

Specific classification codes for further qualifying RoleClass codes.

1 AssocativeRoleType

Definition:

A general association between two entities that is neither partitive nor ontological.

Examples: affiliate; agent; birthplace.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassAssociative

2 . . MutualRelationshipRoleType

Definition:

Description:Concepts which further characterizing the type of mutual relationships. Used only with the abstract code_RoleClassMutualRelationship.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassMutualRelationship

3 . . . AgentRoleType

Definition:

An entity (player) that acts or is authorized to act on behalf of another entity (scoper).

Examples: next of kin; assigned entity; contact.

Property:   ConceptualSpaceForClassCode: RoleClass.AGNT

4 . . . . AdministrativeContactRoleType
. . . .   AdministrativeContactRoleType (X1 as CWE)

Definition:

Description:Indicates the role an entity (player) is playing as the appropriate contact on behalf of another entity (scoper).

4 . . . . AssignedRoleType

Definition:

Description: A role type that is used to further qualify an entity playing a role where the role class attribute is set to RoleClass AssignedEntity. The suggested values from V2.x include clinic receptionist, referral agent, staff physician, courtesy physician, resident, physician assistant, physical therapist, psychiatrist, psychologist, pharmacist, registered nurse, licensed practical nurse, licensed vocational nurse, nurse practitioner, etc.

Examples:

  • Janitor

  • Chief of Staff

  • Referral Agent

  • Security Guard

  • ICU Runner

  • Visiting professor

Property:   ConceptualSpaceForClassCode: RoleClass.ASSIGNED

5 . . . . . AssignedNonPersonLivingSubjectRoleType
. . . . .   AssignedNonPersonLivingSubjectRoleType (X1 as CWE)

Definition:

Description:A role type that is used to further qualify a non-person subject playing a role where the role class attribute is set to RoleClass AssignedEntity

Property:   ConceptualSpaceForClassCode: RoleClass.ASSIGNED

5 . . . . . ClinicalOrganizationRoleType

Definition:

A role of an organization that further classifies the clincial responsibility for the healthcare care delivered during an encounter. E.g. cardiology service, pediatric service, nursing services.

Property:   ConceptualSpaceForClassCode: RoleClass.ASSIGNED

5 . . . . . CommissioningPartyRoleType

Definition:

OpenIssue: This concept domain has no valid description.

Property:   ConceptualSpaceForClassCode: RoleClass.COMPAR

6 . . . . . . GrantorRoleType

Definition:

Description: The specific kinds of roles that issue information privacy grants that permit or prohibit potential actions on information artifacts.

Examples:

  • Parent

  • Legal Guardian

  • Health Information Exchange

Property:   ConceptualSpaceForClassCode: RoleClass.ASSIGNED

7 . . . . . . . GrantorOrganizationRoleType

Definition:

Description: The specific kinds of organizational roles that issue information privacy grants that permit or prohibit potential actions on information artifacts.

Examples:

  • Clearinghouse

  • Billing Service

  • Health Information Exchange

7 . . . . . . . GrantorPersonRoleType

Definition:

Description: The specific kinds of person roles that issue information privacy grants that permit or prohibit potential actions on information artifacts.

Examples:

  • Self

  • Parent

  • Legal Guardian

5 . . . . . DeviceOperatorType

Definition:

Indicates the type of person that is responsible for operating the device related to the incident reported in ICSR.

Examples include: Physician, Nurse, Medical Technician, Respiratory Technician.

Property:   ConceptualSpaceForClassCode: RoleClass.ASSIGNED

5 . . . . . HealthcareProviderRoleType
. . . . .   NUCCProviderCodes (R1 as CWE)

Definition:

A role type that is used to categorize an entity that delivers health care in an expected and professional manner to a subject in need of health care services.

Examples:

  • Registered Nurse

  • Physician

  • Custodial Care Clinic

Property:   ConceptualSpaceForClassCode: RoleClass.ASSIGNED

6 . . . . . . LabSpecimenCollectionProviders
. . . . . .   LabSpecimenCollectionProviders (X1 as CWE)

Definition:

Description:Providers used in Laboratory messaging.

Property:   ConceptualSpaceForClassCode: RoleClass.PROV

5 . . . . . ICSRReportingRoleType

Definition:

Description: A role that is played by a party which is involved in the process originating or managing reports of adverse events or product problems.

Examples:

  • Marketing Authorization Holder

  • Regulatory Agency

  • Healthcare Practitioner

Property:   ConceptualSpaceForClassCode: RoleClass.ASSIGNED

5 . . . . . PersonalAndLegalAssignedRoleType
. . . . .   PersonalAndLegalRelationshipRoleType (X1 as CWE)

Definition:

A ‘personal and legal’ assigned relationship records the role of a person in relation to another person, or a person to himself or herself. These concepts are to be used when recording relationships based on personal or family ties or through legal assignment of responsibility.

5 . . . . . ProductLifecycleAssignedRoleType

Definition:

A code specifying a type of responsibility that an entity may take on with respect the lifecycle of a product.

Examples:

  • Manufacturer

  • Distributor

  • Retailer

4 . . . . ContactRoleType

Definition:

Description: A role type that is used to further qualify or describe the role of the contact person or organization.

Examples:

  • Legal representative
  • Primary contact
  • Alternative contact

Property:   ConceptualSpaceForClassCode: RoleClass.CON

4 . . . . GuardianRoleType

Definition:

Qualify the holder or scope of a guardianship relationship over a living subject.

Examples:

  • Guardianship held jointly by separated parents

  • Guardianship held jointly by parent and another person

  • Natural guardian

  • Special guardian

  • Guardian of property

Property:   ConceptualSpaceForClassCode: RoleClass.GUARD

4 . . . . ProductSafetyReportPartyRoleType

Definition:

Description:Captures the different roles that are recorded to characterize the qualifications or stations in life of persons or organizations who participate as senders or as receivers of adverse event or product problem reports.

Example:Example values may include: physician, healthcare facility, attorney, family member, regulatory agency. Initial effort to find defined concepts for this value set will focus on the HIPAA provider taxonomy.

Property:   ConceptualSpaceForClassCode: RoleClass.AGNT

3 . . . FormalRelationshipRoleType

Definition:

A relationship between two entities that is formally recognized, frequently by a contract or similar agreement.

Examples: agent; guarantor; patient.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassRelationshipFormal

4 . . . . AffiliationRoleType

Definition:

Concepts characterizing the type of association formed by player and scoper when there is a recognized Affiliate role by which the two parties are related.

Examples: Business Partner, Business Associate, Colleague

Property:   ConceptualSpaceForClassCode: RoleClass.AFFL

5 . . . . . CoverageSponsorRoleType
. . . . .   CoverageSponsorRoleType (R1 as CWE)

Definition:

Description:Codes that indicate a specific type of sponsor. Used when the sponsor's role is only either as a fully insured sponsor or only as a self-insured sponsor. NOTE: Where a sponsor may be either, use the SponsorParticipationFunction.code (fully insured or self insured) to indicate the type of responsibility. (CO6-0057)

5 . . . . . PayorRoleType
. . . . .   PayorRoleType (R1 as CWE)

Definition:

Description:PayorRoleType for a particular type of policy or program benefit package or plan where more detail about the coverage administration role of the Payor is required. The functions performed by a Payor qualified by a PayorRoleType may be specified by the PayorParticpationFunction value set.

Examples:A Payor that is a TPA may administer a managed care plan without underwriting the risk.

5 . . . . . ResponsibleParty
. . . . .   ResponsibleParty (R1 as CWE)

Definition:

The role played by a party who has legal responsibility for another party.

6 . . . . . . PowerOfAttorney
. . . . . .   PowerOfAttorney (R1 as CWE)

Definition:

A relationship between two people in which one person authorizes another to act for him in a manner which is a legally binding upon the person giving such authority as if he or she personally were to do the acts.

OpenIssue:

4 . . . . CitizenRoleType
. . . .   CitizenRoleType (R1 as CWE)

Definition:

A role type used to qualify a person's legal status within a country or nation.

Examples:

  • Full citizen

  • Asylum seeker

  • Permit card holder

Property:   ConceptualSpaceForClassCode: RoleClass.CIT

4 . . . . CoveredPartyRoleType
. . . .   CoveredPartyRoleType (R1 as CWE)

Definition:

A role recognized through the eligibility of an identified living subject for benefits covered under an insurance policy or a program. Eligibility as a covered party may be conditioned on a relationship with (1) the policy holder such as the policy holder who is covered as an individual under a poliy or as a party sponsored for coverage by the policy holder.

Example:An employee as a subscriber; or (2) on being scoped another covered party such as the subscriber, as in the case of a dependent.

Discussion: The Abstract Value Set "CoverageRoleType", which was developed for use in the Canadian realm "pre-coordinate" coverage roles with other roles that a covered party must play in order to be eligible for coverage, e.g., "handicapped dependent". Other codes in the Abstract Value Set CoveredPartyRoleType domain can be "post-coordinated" with the EligiblePartyRoleType codes to denote comparable concepts. Decoupling the concepts is intended to support a wider range of concepts and semantic comparability of coded concepts.

Property:   ConceptualSpaceForClassCode: RoleClass.COVPTY

4 . . . . EmployeeRoleType

Definition:

Description: A role type that is used to further qualify an entity playing a role where the role class attribute is set to RoleClass Employee. This specifies the relationship the staff person has with the institution for whom he/she provides services.

Examples:

  • Employee
  • Volunteer
  • Consultant

Property:   ConceptualSpaceForClassCode: RoleClass.EMP

4 . . . . InvestigatedSubjectRoleType

Definition:

Description: A code further classifying the type of investigated subject role. Used with the INVSBJ role class code.

Examples:

  • Case subject

  • Suspect

  • Person of interest

Property:   ConceptualSpaceForClassCode: RoleClass.INVSBJ

5 . . . . . ResearchSubjectRoleBasis
. . . . .   ResearchSubjectRoleBasis (R1 as CWE)

Definition:

Specifies the administrative functionality within a formal experimental design for which the ResearchSubject role was established. Examples: screening - role is used for pre-enrollment evaluation portion of the design; enrolled - role is used for subjects admitted to the active treatment portion of the design.

Property:   ConceptualSpaceForClassCode: RoleClass.RESBJ

4 . . . . LicensedRoleType

Definition:

OpenIssue: This concept domain has no valid description.

Property:   ConceptualSpaceForClassCode: RoleClass.LIC

5 . . . . . ProviderCodes
. . . . .   NUCCProviderCodes (US as CWE)

Definition:

Healthcare Provider Taxonomy Codes

Property:   ConceptualSpaceForClassCode: RoleClass.PROV

4 . . . . QualifiedRoleType

Definition:

Description: A category to which a person can be assigned on the basis of professional qualification, experience, and/or job assignment.

Examples:

  • Physician

  • Registered Nurse

  • Product Quality Manager

Property:   ConceptualSpaceForClassCode: RoleClass.QUAL

5 . . . . . CertifiedEntityType

Definition:

Defines types of certifications for all entities

Property:   ConceptualSpaceForClassCode: RoleClass.QUAL

6 . . . . . . PractitionerCertifiedEntityType

Definition:

Defines types of certifications for practitioners

OpenIssue: This concept domain should be reviewed to determine whether it needs a "ConceptualSpaceForClassCode" property to link to a RIM classCode.

3 . . . PersonalRelationshipRoleType
. . .   PersonalRelationshipRoleType (R1 as CWE)

Definition:

Description: Types of personal relationships between two living subjects.

Examples:

  • Parent

  • sibling

  • unrelated friend

  • neighbor

Property:   ConceptualSpaceForClassCode: RoleClass.PRS

4 . . . . FamilyMemberRelationshipRoleType
. . . .   FamilyMember (R1 as CWE)

Definition:

The type of familial relationship between a living subject and another living subject.

Examples:

  • Father

  • Mother

  • Uncle

2 . . PassiveRoleType

Definition:

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.

Examples: birthplace; owned entity; used entity.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassPassive

3 . . . AdministrativeLocationRoleType

Definition:

OpenIssue: This concept domain has no valid description.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassPassive

3 . . . HealthcareServiceLocation
. . .   HealthcareServiceLocation (C1 as CWE)

Definition:

A set of concepts representing locations and settings where healthcare services are provided.

Property:   ConceptualSpaceForClassCode: RoleClass.SDLOC

4 . . . . DedicatedServiceDeliveryLocationRoleType
. . . .   DedicatedServiceDeliveryLocationRoleType (R1 as CWE)

Definition:

A role of a place that further classifies a setting that is intended to house the provision of services.

Property:   ConceptualSpaceForClassCode: RoleClass.DSDLOC

4 . . . . IncidentalServiceDeliveryLocationRoleType
. . . .   IncidentalServiceDeliveryLocationRoleType (R1 as CWE)

Definition:

Types of locations,that are not designed for the purpose of providing health care services but where care provision takes place.

Examples:

  • Accident site
  • Patient's residence
  • School
  • Work site

Property:   ConceptualSpaceForClassCode: RoleClass.ISDLOC

3 . . . IdentifiedEntityType

Definition:

Definition: A code representing the type of identifier that has been assigned to the identified entity (IDENT).

Examples: Example values include Social Insurance Number, Product Catalog ID, Product Model Number.

Property:   ConceptualSpaceForClassCode: RoleClass.IDENT

4 . . . . LocationIdentifiedEntityRoleType
. . . .   RoleLocationIdentifiedEntity (R1 as CWE)

Definition:

Description:Describes types of identifiers other than the primary location registry identifier for a service delivery location. Identifiers may be assigned by a local service delivery organization, a formal body capable of accrediting the location for the capability to provide specific services or the identifier may be assigned at a jurisdictional level.

4 . . . . PersonIdentifierRoleType

Definition:

Types of identifiers for persons.

Examples:

  • Social insurance number
  • Passport number
  • Drivers license number
  • Jurisdiction health number
4 . . . . SpecimenIdentifierRoleType

Definition:

Description: A role by which one can communicate additional identifiers for a specimen.

Examples:

  • specimen identifier

  • accession identifier

  • container identifier

Property:   ConceptualSpaceForClassCode: RoleClass.IDENT

3 . . . MolecularBondRoleType

Definition:

The nature of the bonds by which two molecular parts may be connected.

Examples: (1) simple bonds such as, single bond, double bond, triple bond, (2) specialized bonds such as peptide bond, disulfide bond, etc., (3) weak bonds such as van-der-Waals, chelate, and ion-associations.

Property:   ConceptualSpaceForClassCode: RoleClass.BOND

3 . . . MolecularFeatureRoleType

Definition:

The generalization of molecular parts (partitive role) and molecular bonds (associative role), or possibly any other role type used for the expression of structural molecular features.

Examples: (1) acetyl group (a moiety), (2) disulfide bond (a bond), (3) O-linked glycosylation (a moiety).

3 . . . NDCRelatedDrugEntityType

Definition:

NDC Regulated Drug Entity Type

Property:   ConceptualSpaceForClassCode: RoleClass.RGPR

3 . . . ProductProcessingOrganizationRoleType

Definition:

Description: Indicates the role that an organization takes in the process by which a product goes from an original manufacturer to the eventual consumer.

Examples:Manufacturer, re-processor

Note:These two values are currently used in adverse event and product problem reporting.

Property:   ConceptualSpaceForClassCode: RoleClass.MANU

3 . . . ProductRegulatoryServicesLocationRoleType

Definition:

Description: Provides the description of the role of a place in terms of its provision of services and functions in the product regulatory domain.

Examples:

  • pharmacovigilance masterfile location
  • COSHH (Control of Substances Hazardous to Health) masterfile location
  • regulatory dossier storage location
  • batch release masterfile location
3 . . . ProductRelatedRoleType

Definition:

Description:Concepts characterizing product related roles.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassPassive

4 . . . . DistributedMaterialRoleType

Definition:

Description:Codes that further characterize the distribution of a material. Used only with the DST (distributed material) role classCode.

Examples:Intensive distribution, Selective distribution and Exclusive distribution.

Property:   ConceptualSpaceForClassCode: RoleClass.DST

4 . . . . ManufacturedProductRoleType

Definition:

Description:A role type that is used to further qualify an entity playing a role where the role class attribute is set to RoleClass ManufacturedProduct.

Property:   ConceptualSpaceForClassCode: RoleClass.MANU

5 . . . . . VisionProductRoleType

Definition:

Description:A role type that is used to further qualify an entity playing a role where the role is that of a vision product such as lenses, frames, etc.

Property:   ConceptualSpaceForClassCode: RoleClass.MANU

4 . . . . RegulatedProductRoleType

Definition:

Description:Codes that further characterize a regulated product role. Used only with the RGPR (regulated product) role classCode.

Example: Regulated drug and regulated device.

Property:   ConceptualSpaceForClassCode: RoleClass.RGPR

4 . . . . RetailedMaterialRoleType

Definition:

Description:Codes that further characterize the association of a material playing the role of a retailed material to the scoper which retails the material. Used only with the RET (retailed material) role classCode.

Examples: Department store, Self-service and Online.

Property:   ConceptualSpaceForClassCode: RoleClass.RET

4 . . . . TheraputicAgentRoleType

Definition:

Description:Codes that further characterize the Theraputic Agent as a manufactured product. Used only with the THER (therapeutic agent) role classCode.

Examples: Generic and Brand name.

Property:   ConceptualSpaceForClassCode: RoleClass.THER

4 . . . . WarrantedProductRoleType

Definition:

Description:Codes that further characterize a warranted product role. Used only with the WRTE (warranted product) role classCode.

Example: Express warranty, Implied Warranty and Lifetime Warranty.

Property:   ConceptualSpaceForClassCode: RoleClass.WRTE

3 . . . RoleAccessType

Definition:

Type of material that provides access to another entity.

Property:   ConceptualSpaceForClassCode: RoleClass.ACCESS

3 . . . TerritorialAuthorityRoleType

Definition:

Description: Concepts which further characterizing the type of territorial authority. Used only with the TERR (territorial authority) role classCode.

Example: public health authority, judicial authority and national authority.

Property:   ConceptualSpaceForClassCode: RoleClass.TERR

1 ICSRParticipantRoleQualificationType

Definition:

Description:Different types of qualification that could be applicable for a party involved in sending or receiving a case safety report, providing the original notification or report of an adverse event or product problem.

Examples:

  • Physician
  • Veterinarian
  • Lawyer
  • Member of the public

Property:   ConceptualSpaceForClassCode: RoleClass.QUAL

1 IDMPRoleCodeType

Definition:

Defines elements of the IDMP model, whether concepts defined by role, or relationships between concepts defined by role, that cannot otherwise easily be distinguished within the Common Product Model structures and associated vocabulary. This domain is a collector for the different types of semantics associated with the IDMP role concept spaces.

Property:   ConceptualSpaceForClassCode: RoleClass.ROL

2 . . IDMPProductType

Definition:

Provides a set of values for defining the type of Pharmaceutical Product that is related to a PhPID. This in turn determines the type of information that may be conveyed when using the Common Product Model as a vehicle for IDMP model data.

Examples:

  • Chemical Type

  • Radionuclides (radioactive) Type

  • Biological Substance

2 . . IDMPRelationType

Definition:

Provides a set of values for defining the relationship between different concepts when using the Common Product Model as a vehicle for IDMP model data

Examples:

  • Medicinal identifier

  • Pharmaceutical identifier

  • Underlying pharmaceutical concept identifier

1 OntologicalRoleType

Definition:

A relationship in which the scoping Entity defines or specifies what the playing Entity is. Thus, the player's "being" (Greek: ontos) is specified.

Examples: sameness; instance; generalization.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassOntological

2 . . EquivalenceEvaluationRoleType

Definition:

A code specifying in what way two products are considered equivalent. One example for a value set in the US can be found in U.S. FDA "Orange Book" at the FDA website but the concept is universal and not a U.S. only issue.

Examples:

  • No known or suspected bioequivalence problems

  • Potential bioequivalence problems have been resolved with evidence supporting bioequivalence

  • Bioequivalence problems have not been fully resolved

Property:   ConceptualSpaceForClassCode: RoleClass.EQUIV

2 . . MedicationGeneralizationRoleType
. .   MedicationGeneralizationRoleType (R1 as CWE)

Definition:

Identifies the specific hierarchical relationship between the playing and scoping medications.

Examples: Generic, Generic Formulation, Therapeutic Class, etc.

Property:   ConceptualSpaceForClassCode: RoleClass.GEN

1 PartitiveRoleType

Definition:

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.

Examples: part; member; ingredient.

Property:   ConceptualSpaceForClassCode: RoleClass._RoleClassPartitive

2 . . LocatedEntityRoleType

Definition:

Description: Constrains the concepts used to further characterize the association between an entity and itaTMs location. Used only with the LOCE (located entity) role classCode.

Example: home, business and vacation home.

Property:   ConceptualSpaceForClassCode: RoleClass.LOCE

2 . . MemberRoleType
. .   MemberRoleType (X1 as CWE)

Definition:

A classification for further qualifying an entity playing a Member RoleClass.

Examples:

  • tribal member
  • elected member
  • ex officio member
  • part-time member
2 . . PartRoleType

Definition:

Description: Concepts which further characterizing the association two Entities where the playing Entity (the part) is a component of the whole (scoper). Used only with the PART (part) role classCode.

Example: Body part, organization part and moiety.

Property:   ConceptualSpaceForClassCode: RoleClass.PART

3 . . . MolecularPartRoleType

Definition:

The senses in which a molecule may be conceptually or actually divided into parts.

Examples:

  1. sub-unit of a protein (i.e., sequences held together usually by disulfide bonds);
  2. domain of a protein or component of a nucleic acid sequence (i.e., a sub-sequence identified to have a certain folding structure or function, e.g. signaling peptide of a protein precursor or promoter and open reading frame of a nucleic acid);
  3. residue on a molecular base skeleton; atom of a molecule (e.g., to identify substitution with a radioactive isotope);
  4. dissociable ion.

UsageNotes: The specific code system and concepts are left to be externally defined. However, when the positionNumber attribute is to be used with the part role to indicate where the part is placed, the part role code must specify how the position number vector is to be interpreted. For example, for subunits of a protein oligomer (such as fibrinogen) held together by disulfide bonds, the part relationship would need to specify the position of the links

3 . . . OrganizationPartRoleType

Definition:

Waiting on description from Austin.

2 . . SpecimenRoleType
. .   SpecimenRoleType (UV as CWE)

Definition:

Description: Further classifies the types of specimen roles.

Examples: Examples include Quality control specimens, grouped specimens and patient specimens.

Property:   ConceptualSpaceForClassCode: RoleClass.SPEC

3 . . . DerivedSpecimenRoleType

Definition:

Description: Specimen types which further classify the types of specimens that are derived from other specimens.

Examples: Examples include specimen sections and specimen components.


Return to concept domain index
RoleLinkStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RoleLinkStatus
 RoleLinkStatus (UV as CNE)
RoleLink .statusCode (CS)

Definition:

Description:The status of an instance of the RIM RoleLink class.

Constraint: It is intended to be used based on usage of the ParticipationType concept domain.

Examples:
  • Active
  • No longer active
  • Nullified

Return to concept domain index
RoleLinkType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RoleLinkType
 RoleLinkType (UV as CNE)
RoleLink .typeCode (CS)

Definition:

A code specifying the kind of connection represented by this RoleLink, e.g., has-part, has-authority.


Return to concept domain index
RoleStatus     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RoleStatus
 RoleStatus (UV as CNE)
Role .statusCode (CS)

Definition:

The status of an instance of the RIM Role class.


Return to concept domain index
RouteOfAdministration     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 RouteOfAdministration
 RouteOfAdministration (R1 as CWE)
Exposure .routeCode (CD)
SubstanceAdministration .routeCode (CD)

Definition:

Description:This describes which path the administered medication takes to get into the body or into contact with the body and constitutes part of the where (the other part being site - see below). It is the way in or the course the medication must take to get to its destination.

Note that a path is in no sense a description of a final destination; it is a stylized description of the path taken. For example, an oral antibiotic may be used to treat a severe infection on a toe; the oral route is used to get the medicine to be able to reach and treat the infection in the toe. For some specific routes of administration there may be an incidental sense of final destination, for example an ocular administration usually occurs when treatment of an eye condition is required. However, this is in no sense definitional: rectal administration of a medicine may be for a local effect (a steroid foam for treatment of colitis) or for a systemic effect (metronidazole for treatment of infection). The route of administration of a medicine should only be a description of the path taken and not the form.

Examples:

  • oral

  • rectal

  • intravenous (IV)

  • subcutaneous (SC)

  • intramuscular (IM)


Return to concept domain index
Sequencing     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 Sequencing
 Sequencing (UV as CNE)
SortControl .directionCode (CS)

Definition:

DESCRIPTION:

Examples:

  • Ascending
  • Descending
  • None

Return to concept domain index
SetOperator     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 SetOperator
 SetOperator (UV as CWE)

Definition:

OpenIssue:


Return to concept domain index
SoftwareName     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 SoftwareName Device .softwareName (SC)

Definition:

Provides coded names for attribute Device.softwareName, which has data type SC.


Return to concept domain index
SpecialArrangement     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 SpecialArrangement PatientEncounter .specialArrangementCode (DSET<CD>)

Definition:

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.


Return to concept domain index
StyleType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 StyleType
 StyleType (C1 as CWE)

Definition:

(abstract) Used within an instance to give the author some control over various aspects of rendering


Return to concept domain index
SubstitutionCondition     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 SubstitutionCondition
 SubstitutionCondition (C1 as CWE)
Participation .substitutionConditionCode (CD)

Definition:

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.


Return to concept domain index
TableCellHorizontalAlign     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TableCellHorizontalAlign
 TableCellHorizontalAlign (C1 as CWE)

Definition:

These values are defined within the XHTML 4.0 Table Model


Return to concept domain index
TableCellScope     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TableCellScope
 TableCellScope (C1 as CWE)

Definition:

These values are defined within the XHTML 4.0 Table Model


Return to concept domain index
TableCellVerticalAlign     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TableCellVerticalAlign
 TableCellVerticalAlign (C1 as CWE)

Definition:

These values are defined within the XHTML 4.0 Table Model


Return to concept domain index
TableFrame     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TableFrame
 TableFrame (C1 as CWE)

Definition:

These values are defined within the XHTML 4.0 Table Model


Return to concept domain index
TableRules     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TableRules
 TableRules (C1 as CWE)

Definition:

These values are defined within the XHTML 4.0 Table Model


Return to concept domain index
TargetAwareness     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TargetAwareness
 TargetAwareness (R1 as CWE)
Participation .awarenessCode (CD)

Definition:

A code specifying the extent to which the Entity playing the participating Role (usually as a target Participation) is aware of the associated Act.

Examples: For diagnostic observations, is the patient, family member or other participant aware of his terminal illness?

Discussion: If the awareness, denial, unconsciousness, etc. is the subject of medical considerations (e.g., part of the problem list), one should use explicit observations in these matters as well, and should not solely rely on this simple attribute in the Participation.


Return to concept domain index
TelecommunicationAddressUse     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TelecommunicationAddressUse
 TelecommunicationAddressUse (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
TelecommunicationCapabilities     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TelecommunicationCapabilities

Definition:

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.


Return to concept domain index
TimingEvent     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TimingEvent
 TimingEvent (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
TransmissionRelationshipType     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 TransmissionRelationshipType
 TransmissionRelationshipTypeCode (UV as CNE)
TransmissionRelationship .typeCode (CS)

Definition:

A codes specifying the meaning and purpose of every TransmissionRelationship instance. Each of the values implies specific constraints to what kinds of Transmission objects can be related and in which way.


Return to concept domain index
UnitsOfMeasureCaseSensitive     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 UnitsOfMeasureCaseSensitive
 UnitsOfMeasureCaseSensitive (UV as CNE)

Definition:

OpenIssue:


Return to concept domain index
URLScheme     
Lvl Concept Domain Name
  Value Set Binding
RIM Attribute(s) Definition/Description
0 URLScheme
 URLScheme (UV as CNE)

Definition:

A Universal Resource Locator (URL) is a type of telecommunications address specified as Internet standard RFC 1738 [http://www.isi.edu/in-notes/rfc1738.txt]. The URL specifies the protocol and the contact point defined by that protocol for the resource.


Return to concept domain index