COCT_MT080200UV09 - Hierarchical Message Description

COCT_MT080200UV09
R_Specimen lite

Derived from RMIM: COCT_RM080200UV09 and HMD: COCT_HD080200UV09

Specimen

Design Comments: The specimen itself is the subject, or the product, of the process which may be optionally communicated.

classCode [1..1] (M)
Role (CS) {CNE:V:RoleClassSpecimen, root= "SPEC"}

Design Comments: The classCode is constrained to "SPEC". This could be either a specimen, aliquot or isolate.

id [1..1]
Role (II)

Design Comments: This attribute is used for the business id to distinguish this specimen from any other specimen.

code [1..1]
Role (CD) {CWE:D:SpecimenRoleType}

Design Comments: This attribute is used to categorize the type of specimen role associated with this class. This will be a code that describes the type of specimen role such as specimen, aliquot, isolate.

specimenNatural [1..1] (Natural)

Design Comments: An entity comprised of naturally occuring substance in the role of specimen.

subjectOf1 [0..*] (Subject1)

Design Comments: The specimen is the subject of zero to many ProcessChoice acts.

subjectOf2 [0..*] (Subject2)

Design Comments: The Specimen is subject of zero to many ActReferences or Annotations.

productOf [0..1] (Product)

Design Comments: The Specimen is the product of zero to one SpecimenProcessSteps or SpecimenCollectionProcess. This identifies the specimen, via its role, that is the product of a process. This process may be any act from the ProductChoice. Where this is the original specimen, the SpecimenCollectionProcess will generally be the appropriate process but, where there is an aliquoting or other specimen treatment that results in a "new specimen," the SpecimenProcessStep is appropriate..

Natural

Design Comments: An entity comprised of naturally occuring substance in the role of specimen.

classCode [1..1] (M)
Entity (CS) {CNE:V:EntityClassRoot, root= "ENT"}

Design Comments: Signifies that a specimen can be virtually anything.

determinerCode [1..1] (M)
Entity (CS) {CNE:V:EntityDeterminer}

Design Comments: The determinerCode should be set to INSTANCE, KIND or QUANTIFIED_KIND.

code [1..1] (M)
Entity (CD) {CNE:D:SpecimenEntityType}

Design Comments: The Code categorizing the type of natural substance such as Serum, soil, water, or any natural substance

desc [0..1]
Entity (ED)

Design Comments: A renderable textual or multimedia description of the natural substance (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Entity. Please see the RIM Entity.text description for further clarification of the use of this attribute.

riskCode [0..1]
Entity (CD) {CWE:D:EntityRisk}

Design Comments: Identifies any risk associated with the specimen or handling the specimen such as an infectious agent.

handlingCode [0..1]
Entity (CD) {CWE:D:EntityHandling}

Design Comments: Ways to handle a specimen. For example, protect from air or keep frozen.

asSpecimenStub [0..*] (SpecimenStub)

Design Comments: The SpecimenStub serves two purposes.

When the associated entity is playing the role of specimen, then SpecimenStub conveys other specimen id's for the specimen.

When the associated entity is scoping the role of specimen (i.e., it is a parent specimen) SpecimenStub carries the specimen id for the parent as well as addtional specimen ids for the parent specimen.

asSpecimenInContainer [0..1] (SpecimenInContainer)

Design Comments: The specimenEntities play the role of content for a container.

asOtherIDs [0..*] (OtherIDs)

Design Comments: An identifying relationship between the focal entity and a scoping organization. Note that this could be an identifier used by the primary scoping organization in a different context. The ids carried in this role are intended to be interoperable because they are associated with a specific Role class code.

SpecimenStub

Design Comments: The SpecimenStub serves two purposes.

When the associated entity is playing the role of specimen, then SpecimenStub conveys other specimen id's for the specimen.

classCode [1..1] (M)
Role (CS) {CNE:V:RoleClassSpecimen, root= "SPEC"}

Design Comments: The classCode is constrained to "SPEC".

id [1..1]
Role (II)

Design Comments: This attribute is used for the business id to distinguish this specimen from any other specimen.

SpecimenInContainer

Design Comments: The specimenEntities play the role of content for a container.

classCode [1..1] (M)
Role (CS) {CNE:V:RoleClassContent, root= "CONT"}

Design Comments: The classCode is constrained to "CONT".

container [1..1] (Container)

Design Comments: The container entity contains the specimen and may also itself be the content of a holder, such as a vial containing a specimen that is placed in a carrier.

Container

Design Comments: The container entity contains the specimen and may also itself be the content of a holder, such as a vial containing a specimen that is placed in a carrier.

classCode [1..1] (M)
Container (CS) {CNE:V:EntityClassContainer, root= "CONT"}

Design Comments: The classCode is constrained to "CONT".

determinerCode [1..1] (M)
Container (CS) {CNE:V:EntityDeterminer}

Design Comments: The determinerCode should be set to INSTANCE, KIND or QUANTIFIED_KIND.

id [0..1]
Container (II)

Design Comments: This attribute is used for the business id to distinguish this Container from any other Container. Container.id is used only where the id is integral to the container. For example, many tubes and cassettes come with barcode id’s already printed on the container. ID’s from labels that are subsequently attached to the container should use the IdentifiedHolderContaineOrAdditive.id.

code [0..1]
Container (CD) {CWE:D:ContainerEntityType}

Design Comments: A code that specifies the The type of container.

desc [0..1]
Container (ED)

Design Comments: A renderable textual or multimedia description of the container (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Entity. Please see the RIM Entity.text description for further clarification of the use of this attribute.

riskCode [0..1]
Container (CD) {CWE:D:EntityRisk}

Design Comments: Risk associated with the container or material contained in the container.

handlingCode [0..1]
Container (CD) {CWE:D:EntityHandling}

Design Comments: Ways to handle the container, such as frozen or room temperature.

capacityQuantity [0..1]
Container (PQ)

Design Comments: The capacity of the container.

heightQuantity [0..1]
Container (PQ)

Design Comments: The height of the container.

diameterQuantity [0..1]
Container (PQ)

Design Comments: The diameter of the container.

capTypeCode [0..1]
Container (CD) {CWE:D:ContainerCap}

Design Comments: The code indicating the type of cap used on the container.

separatorTypeCode [0..1]
Container (CD) {CWE:D:ContainerSeparator}

Design Comments: The code indicating the type of separator used in the container.

barrierDeltaQuantity [0..1]
Container (PQ)

Design Comments: The difference between the top of the tube and the top of the tube container.

bottomDeltaQuantity [0..1]
Container (PQ)

Design Comments: The difference between the bottom of the tube and the bottom of the tube container.

OtherIDs

classCode [1..1] (M)
Role (CS) {CNE:V:RoleClassRoot, root= "ROL"}

Design Comments: Structural attribute. This can be any specialization of "role".

id [1..*] (M)
Role (DSET<II>)

Design Comments: One or more identifiers issued to the focal living subject by the associated assigningOrganization.

code [0..1]
Role (CD) {CWE:D:RoleCode}

Design Comments: A value further specifying the identifier the scoping organization has assigned to the playing entity. For example, this could distinguish between driver licenses and state identification cards issued by state Departments of Motor Vehicles.

scopingOrganization [0..1] (E_OrganizationUniversal)

Subject1

Design Comments: The specimen is the subject of zero to many ProcessChoice acts.

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationTargetSubject, root= "SBJ"}

Design Comments: The typeCode has been constrained to 'SBJ'.

contextControlCode [1..1] (M)
Participation (CS) {CNE:V:ContextControl, default= "OP"}

Design Comments: A code that specifies how this participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation (see ActRelationship.contextConductionInd). The default value of OP has been associated with this participation.

sequenceNumber [0..1]
Participation (INT.NONNEG)

Design Comments: This is used for sequencing purposes only.

processChoice [1..1] (ProcessChoice)

ProcessChoice

definition [0..1] (Definition)

Design Comments: The definition act relationship is used to associate a ProcessChoice with its ActDefinition (master file). The source act is an instance of the target definition act.

precondition [0..*] (Precondition)

Design Comments: Associates specific criteria that apply prior to a particular Specimen process. The process choice for the specimen may have any number of Criterion Observations as a precondition, such as fasting before a glucose tolerance test.

choice of ProductOfChoice

or ObservationEvent

Design Comments: An observation performed related to an entity in the role of specimen. Observations are actions performed in order to determine an answer or result value. Observation result values (Observation.value) include specific information about the observed object in this case a specimen.

Definition

Design Comments: The definition act relationship is used to associate a ProcessChoice with its ActDefinition (master file). The source act is an instance of the target definition act.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipInstantiatesMaster, root= "INST"}

Design Comments: The typeCode for definition is constrained to "INST".

contextControlCode [1..1] (M)
ActRelationship (CS) {CNE:V:ContextControl, default= "AN"}

Design Comments: A code that specifies how this ActRelationship contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation (see ActRelationship.contextConductionInd). The fixed value of AN has been associated with this act relationship.

contextConductionInd [1..1] (M)
ActRelationship (BL)

Design Comments: If the indicator is true, associations in the parent act are conducted across the ActRelationship to the child act. The fixed value of 'false" has been associated with this attribute.

actDefinition [1..1] (ActDefinition)

Design Comments: The ActDefinition class represents the definition (master file) for the associated ProcessChoice. Typically this definition is drawn from the local service catalog.

ActDefinition

Design Comments: The ActDefinition class represents the definition (master file) for the associated ProcessChoice. Typically this definition is drawn from the local service catalog.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassRoot, root= "ACT"}

Design Comments: The classCode for ObservationEvent is constrained to "ACT".

moodCode [1..1] (M)
Act (CS) {CNE:C:ActMood:DEF, fixed value= "DEF"}

Design Comments: ActDefinition is in Definition mood. This has been fixed to "DEF" in the RMIM.

id [1..1] (M)
Act (II)

Design Comments: The ActDefinition.id attribute is used to distinguish this definition from any other definition.

text [0..1]
Act (ED)

Design Comments: A renderable textual or multimedia description (or reference to a description) of the complete information which would reasonably be expected to be displayed to a human reader conveyed by the Act. Please see the RIM Act.text description for further clarification of the use of this attribute.

Precondition

typeCode [1..1] (M)
ActRelationship (CS) {CNE:V:ActRelationshipHasPre-condition, root= "PRCN"}

Design Comments: The typeCode for precondition is constrained to "PRCN".

contextControlCode [1..1] (M)
ActRelationship (CS) {CNE:V:ContextControl, default= "AN"}

Design Comments: A code that specifies how this ActRelationship contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation (see ActRelationship.contextConductionInd). The default value of AN has been associated with this act relationship.

contextConductionInd [1..1] (M)
ActRelationship (BL)

Design Comments: If the indicator is true, associations in the Process are conducted to the Criterion. The default value of 'false" has been associated with this attribute.

sequenceNumber [0..1]
ActRelationship (INT.NONNEG)

Design Comments: This is used for sequencing purposes only.

conjunctionCode [0..1]
ActRelationship (CS) {CNE:V:RelationshipConjunction, default= "AND"}

Design Comments: A code specifying the logical conjunction of precondition criteria for the Process (e.g., and, or, exclusive-or).

criterion [1..1] (Criterion)

Design Comments: A precondition observation for the ProcessChoice. An example is a precondition of fasting for a specimen collection procedure.

Criterion

Design Comments: A precondition observation for the ProcessChoice. An example is a precondition of fasting for a specimen collection procedure.

classCode [1..1] (M)
Observation (CS) {CNE:V:ActClassObservation, root= "OBS"}

Design Comments: The classCode for Criterion is constrained to "OBS".

moodCode [1..1] (M)
Observation (CS) {CNE:V:ActMoodEventCriterion, root= "EVN.CRT"}

Design Comments: The moodCode has been constrained to 'EVN.CRT'.

code [1..1] (M)
Observation (CD) {CWE:D:ActCode}

Design Comments: A code that represents a particular type of an Act that is a precondition ProcessChoice.

value [0..1]
Observation (ANY) {CWE:D:ObservationValue}

Design Comments: The resulting value of the observation such as length of time.

ObservationEvent

classCode [1..1] (M)
Observation (CS) {CNE:V:ActClassObservation, root= "OBS"}

Design Comments: The classCode for SpecimenObservationEvent is constrained to "OBS".

moodCode [1..1] (M)
Observation (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: ObservationEvent is in Event mood. This has been fixed to "EVN" in the CMET.

code [1..1] (M)
Observation (CD) {CNE:V:ActSpecObsCode}

Design Comments: This attribute is used to categorize the type of observation associated with this class. This will be a code that describes the type of observation.

value [1..1]
Observation (ANY) {CWE:D:ObservationValue}

Design Comments: Note that the units of measure if applicable would be carried as part of the PQ (Physical Quantity data type). Information that is assigned or determined by the observation action. V alue is normally present for Observations in Event mood (i.e., the value of the test being reported). The value can be of ANY data type. The ANY data type is an abstract data type that is the parent of all concrete data types. The appropriate data type of the value varies with the kind of Observation and can generally be described in Observation definitions or in a simple relation that pairs Act.codes to value data types. The following guidelines govern the choice of the appropriate value data type: 1. Quantitative measurements use the data type Physical Quantity (PQ) in general. A PQ is essentially a real number with a unit. This is the general preference for all numeric values, subject to a few exceptions listed below. Numeric values must not be communicated as simply a character string (ST). 2. Titer (e.g., 1:64) and very few other ratios use the data type Ratio (RTO). For titers, the ratio would be a ratio of two integer numbers (e.g., 1:128). Other ratios may relate different quantitative data types, such as a "price" specified in Physical Quantity over Monetary Amount. Sometimes by local conventions titers are reported as just the denominator (e.g., 32 instead of 1/32). Such conventions are confusing and should be converted into correct ratios in HL7 messages. 3. Index values (a number without unit) uses the Real Number (REAL) data type. When a quantity does not have a proper unit, one can just send the number as a real number. Alternatively one can use a PQ with a dimensionless unit (e.g., 1 or %). An integer number should only be sent when the measurement is by definition an integer, which is an extremely rare case and then is most likely an ordinal (see below). 4. Ranges (e.g., <3; 12-20) must be expressed as Interval of Physical Quantity (IVL<PQ>) or intervals of other quantity data types. Sometimes such intervals are used to report the uncertainty of measurement value. For uncertainty there are dedicated data type extensions available. 5. Ordinals (e.g., +, ++, +++; or I, IIa, IIb, III, IV) use the Coded Ordinal (CO) data type. 6. Nominal results ("taxons", e.g., organism type). use any of the coded data types (CD, CE) that specify at least a code and a coding system, and optionally original text, translations to other coding systems and sometimes qualifiers. 7. The character string data type may exceptionally be used to convey formalized expressions that do not fit in any of the existing data types. However, the string data type must not be used if the meaning can be represented by one of the existing data types. 8. Timestamps should not be sent in Observations if there are more appropriate places to send those, e.g., usually as Act.effectiveTime of some act. (E.g., "specimen received in lab" is in the effectiveTime of an Act describing the specimen transport to the lab, not in an Observation. 9. Sets of values of any data type, enumerated sets as well as intervals, are often used for Observation criteria (event-criterion mood) to specify "normal ranges" or "decision ranges" (for alerts) etc. 10. For sequences of observations (repeated measurements of the same property during a relatively short time) a Sequence (LIST) data type is used. 11. Uncertainty of values is specified using the Probability and Probability Distribution data type extensions (UVP, PPD). If a statistical sample is reported with absolute frequencies of categories a Bag collection (BAG) can be used efficiently.

Inherits associations from ProcessChoice

Subject2

Design Comments: The Specimen is subject of zero to many ActReferences or Annotations.

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationTargetSubject, root= "SBJ"}

Design Comments: The typeCode is constrained to "SBJ".

contextControlCode [1..1] (M)
Participation (CS) {CNE:V:ContextControl, default= "OP"}

sequenceNumber [0..1]
Participation (INT.NONNEG)

Design Comments: This is used for sequencing purposes only.

actReference [1..1] (ActReference)

Design Comments: An act reference to another act related to the specimen.

ActReference

Design Comments: An act reference to another act related to the specimen.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassRoot, root= "ACT"}

Design Comments: The classCode for ActRef is fixed to "ACT".

moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: The moodCode for ActRef is fixed to "EVN".

id [1..1] (M)
Act (II)

Design Comments: A business id used to distinguish this act from all other acts.

Product

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationProduct, root= "PRD"}

Design Comments: The typeCode for productOf is constrained to "PRD".

contextControlCode [1..1] (M)
Participation (CS) {CNE:V:ContextControl, default= "OP"}

time [0..1]
Participation (IVL<TS>)

Design Comments: An interval of time specifying the time during which the specimen is produced in the ProductChoice act through this Participation.

productOfChoice [1..1] (ProductOfChoice)

ProductOfChoice

choice of TransportationProcessStep

Design Comments: A TransportationProcessStep is performed on a specimen.

or SpecimenCollectionProcess

Design Comments: SpecimenCollectionProcess documents the obtaining or planed obtaining of an original specimen from the subject of interest.

UsageNotes: Used for the Specimen Collection Procedure of the original specimen only. This may have a precondition.

TransportationProcessStep

Design Comments: A TransportationProcessStep is performed on a specimen.

classCode [1..1] (M)
Act (CS) {CNE:V:ActClassTransportation, root= "TRNS"}

Design Comments: Class code has been constrained to 'TRNS'.

moodCode [1..1] (M)
Act (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"}

Design Comments: The act is an event.

code [1..1] (M)
Act (CV) {CNE:D:ActSpecimenTransportCode}

Design Comments: The specific specimen transport code for this act.

effectiveTime [1..1] (M)
Act (TS)

Design Comments: The time the ProcessStep is effective.

SpecimenCollectionProcess

Design Comments: SpecimenCollectionProcess documents the obtaining or planed obtaining of an original specimen from the subject of interest.

UsageNotes: Used for the Specimen Collection Procedure of the original specimen only. This may have a precondition.

classCode [1..1] (M)
Procedure (CS) {CNE:V:ActClassSpecimenCollection, root= "SPECCOLLECT"}

Design Comments: The classCode forSpecimenCollectionProcess is constrained to "SPECCOLLECT".

moodCode [1..1] (M)
Procedure (CS) {CNE:V:x_ActMoodIntentEvent}

Design Comments: Provides the mood code for the specimen collection process act.

id [0..1]
Procedure (II)

Design Comments: This attribute is used to distinguish this SpecimenCollectionProcess from any other SpecimenCollectionProcess. Multiple ids are supported to allow inclusion of both a snapshot id as well as a business id.

code [1..1] (M)
Procedure (CD) {CWE:D:ActSpecimenCollectionProcedureCode}

Design Comments: The Code for the means by which the act is carried out. This is generally the collection method such as 'Biopsy', 'Fine needle aspiration' etc.

statusCode [1..1] (M)
Procedure (CS) {CNE:V:ActStatus, default= "completed"}

Design Comments: The status of the SpecimenCollectionProcess such as aborted or completed.

effectiveTime [0..1]
Procedure (QSET<TS>)

Design Comments: The time the SpecimenCollectionProcess is effective. This is the collection time which is the clinically significant time for tests carried out on that specimen.

performer [0..*] (Performer)

Design Comments: Identifies the performer of the ProcessChoice. This may be an assigned entity or a patient.

Performer

Design Comments: Identifies the performer of the ProcessChoice. This may be an assigned entity or a patient.

typeCode [1..1] (M)
Participation (CS) {CNE:V:ParticipationPhysicalPerformer, root= "PRF"}

Design Comments: The typeCode is constrained to "PRF".

contextControlCode [1..1] (M)
Participation (CS) {CNE:V:ContextControl, default= "OP"}

sequenceNumber [0..1]
Participation (INT.NONNEG)

Design Comments: This is used for sequencing purposes only.

noteText [0..1]
Participation (ST)

Design Comments: A textual or multimedia depiction of commentary related to the participation. This note is attributed to this participant only.

time [0..1]
Participation (IVL<TS>)

Design Comments: An interval of time specifying the time during which the performer is involved in the process act through this Participation.

assignedOrPatient [1..1] (AssignedOrPatient)

AssignedOrPatient

choice of R_PatientUniversal

or R_AssignedEntityUniversal