| COCT_MT841500UV09 E_PublicHealthPhysicalEntity universal |
Derived from RMIM: COCT_RM841500UV09 and HMD: COCT_HD841500UV09 |
||||||||
| PublicHealthEntityChoice | |||||||||
| asQualifiedEntity [0..*] (QualifiedEntity) |
Design Comments: Documents any credentials the entity may have. The qualified role is scoped by the organization issuing the credentials. |
||||||||
| asIdentifier [0..*] (Identifier) |
Design Comments: This role is primarily used to communicate identifiers that are not intended to be interoperable. Interoperable IDs should be carried in the OtherIDs class and associated with the appropriate Role class code. Rationale: Identifiers handled separate from entity so that scoping organization information and type code (role.code) for identifier can be communicated. Design Comments: The scoping organization carries sufficient information to contact the organization regarding the entity in the identified role. |
||||||||
| asPartOfWhole [0..*] (PartOfWhole) |
Design Comments: An association between an entity (player) and another entity (scoper) where the playing entity is considered in a "part" of the other entity, e.g. body part. This role should be used only if other roles in the model such as MBR (member), INGR (ingredient), LOCE (located entity) or CONT (content) are not appropriate. Note the model includes a 'quantity' attribute for relationships that can be quantified as a numeric ratio. Design Comments: HL7: This role is identical to the Part role, except that it reverses the direction of traversal. |
||||||||
| asMemberOf [0..*] (MemberOf) |
Design Comments: An entity may be a member of a group. Entities may be grouped together for a variety purposes ranging from formal groups (such as organizations) to informal groupings for a variety of purposes (such as all the pencils in a pencil holder). The member role is played by the entity and scoped by a group. |
||||||||
| asObserved [0..1] (Observed) |
Design Comments: A public health entity may have additional characteristics that are describe via this role and its associated observations. Design Comments: HL7: Observed is a role that associates an entity with a set of observations. The entity is the subject of the observations. |
||||||||
| 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. |
||||||||
| asManagingEntity [0..*] (ManagingEntity) |
Design Comments: The ManagingEntity role class associates a playing entity which either owned by, hold by, maintained by or accessed through the scoping entity. This class is traversed from the player to the scoper. Depending upon jurisdiction or culture, there may be restrictions on what entities can act as owners, and what entities can be owned. |
||||||||
| contactParty [0..*] (ContactParty) |
Design Comments: Captures contact information for a person who can provide information regarding the public health entity. |
||||||||
| relatedEntity [0..*] (RelatedEntity) |
Design Comments: A relationship that is based on mutual behavior of the public health entity and a related party. The basis of such relationship may be agreements (e.g., spouses, contract parties) or they may be de facto behavior (e.g. friends) or may be an incidental involvement with each other (e.g. parties over a dispute, siblings, children). This is a generalized relationship model that, in a message instance, must be more narrowly defined through a combination of two coded values: one, a RIM classcode to indicate the category of the social relationship (e.g. the "personal relationship" class) and two, a role code to refine the type of relationship being reported (e.g. "sibling"). Rationale: Social relationships are recorded by Public Health as precursors to contact tracing. The assumption is that a subject's associations may be indicative of interactions in which an infectious disease could be transmitted. These facts of association are distinguished from fact of interaction (involving contacts). |
||||||||
| part [0..*] (Part) |
Design Comments: An association between an entity (player) and another entity (scoper) where the playing entity is considered in a "part" of the other entity, e.g. body part. This role should be used only if other roles in the model such as MBR (member), INGR (ingredient), LOCE (located entity) or CONT (content) are not appropriate. Note the model includes a 'quantity' attribute for relationships that can be quantified as a numeric ratio. Design Comments: HL7: This role is identical to the PartOfWhole role, except that it reverses the direction of traversal. |
||||||||
| locatedEntity [0..*] (LocatedEntity) |
Design Comments: Used to identify the physical presence of an entity (e.g. location of a person). Allows for nested-definitions of locations (e.g. place within a place within a place). |
||||||||
| managedEntity [0..*] (ManagedEntity) |
Design Comments: The ManagedEntity role class associates a scoping entity which either owns, holds, maintains or controls access to the playing entity. This class is traversed from the scoper to the player. |
||||||||
| choice of PublicHealthLivingSubject | |||||||||
| or PublicHealthPlaceOrMaterialChoice | |||||||||
| or Entity |
Design Comments: An entity of interest to public health. The Entity class should only be used when the entity is not better represented by one of the other choices in the PublicHealthEntityChoice. |
||||||||
| or EntityGroup |
Design Comments: A group of entities. This may be a formal or ad-hoc grouping of entities. The appropriate class code should be used for the purpose of creating an entity group. If determinerCode is INSTANCE then this is an instance of a group. If determinerCode is KIND then this is a kind of group. The group may be composed of any type of entity, there is no requirement that the group be of all the same type of entity. The Member role is used to associate the members of a group with the group. |
||||||||
| QualifiedEntity |
Design Comments: Documents any credentials the entity may have. The qualified role is scoped by the organization issuing the credentials. |
||||||||
| classCode [1..1] (M) QualifiedEntity (CS) {CNE:V:RoleClassQualifiedEntity, root= "QUAL"} |
|||||||||
| id [0..1] QualifiedEntity (II) |
Design Comments: A unique identifier for this qualified role. |
||||||||
| code [1..1] (M) QualifiedEntity (CD) {CWE:D:QualifiedRoleType} |
Design Comments: A code further identifying the type of qualified role. |
||||||||
| name [0..1] QualifiedEntity (TN) |
Design Comments: A name for the qualified role. |
||||||||
| effectiveTime [0..1] QualifiedEntity (IVL<TS>) |
Design Comments: The effective time of the qualification. |
||||||||
| certificateText [0..1] QualifiedEntity (ED) |
Design Comments: RIM: A textual or multimedia depiction of a certificate issued by the scoping Entity of a Role certifying that this Role is indeed played by the player Entity. |
||||||||
| qualificationGrantingOrganization [0..1] (E_OrganizationUniversal) | |||||||||
| Identifier |
Design Comments: This role is primarily used to communicate identifiers that are not intended to be interoperable. Interoperable IDs should be carried in the OtherIDs class and associated with the appropriate Role class code. Rationale: Identifiers handled separate from entity so that scoping organization information and type code (role.code) for identifier can be communicated. Design Comments: The scoping organization carries sufficient information to contact the organization regarding the entity in the identified role. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassIdentifiedEntity, root= "IDENT"} |
|||||||||
| id [1..1] (M) Role (II) |
Design Comments: A unique identifier by which the identified entity is known. |
||||||||
| code [0..1] Role (CD) {CWE:D:IdentifiedEntityType} |
Design Comments: A code further identifying the type of identified entity role. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: Time period in which the identification information is in effect and is appropriate for use. |
||||||||
| assigningOrganization [0..1] (E_OrganizationUniversal) | |||||||||
| PartOfWhole |
Design Comments: An association between an entity (player) and another entity (scoper) where the playing entity is considered in a "part" of the other entity, e.g. body part. This role should be used only if other roles in the model such as MBR (member), INGR (ingredient), LOCE (located entity) or CONT (content) are not appropriate. Note the model includes a 'quantity' attribute for relationships that can be quantified as a numeric ratio. Design Comments: HL7: This role is identical to the Part role, except that it reverses the direction of traversal. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassPart, root= "PART"} |
|||||||||
| id [0..1] Role (II) |
Design Comments: A unique identifier for the relationship between the playing the role of part and the scoping entity. Note that the scoper of the role will normally not be the issuer of the id. |
||||||||
| code [0..1] Role (CD) {CWE:D:PartRoleType} |
Design Comments: A coded value that more precisely defines the type of part. |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: A code indicating the operative state of the relationship e.g. normal, cancelled, terminated. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: An interval of time specifying the period during which the relationship is in effect, if such time limit is applicable and known |
||||||||
| quantity [0..1] Role (RTO<PQ,PQ>) |
Design Comments: For compositional relationships between (usually) material substances: a ratio (numerator : denominator) specifying the relative quantities of the subject relative to the related entity. |
||||||||
| wholePublicHealthEntityChoice [0..1] (PublicHealthEntityChoice) | |||||||||
| MemberOf |
Design Comments: An entity may be a member of a group. Entities may be grouped together for a variety purposes ranging from formal groups (such as organizations) to informal groupings for a variety of purposes (such as all the pencils in a pencil holder). The member role is played by the entity and scoped by a group. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassMember, root= "MBR"} |
|||||||||
| id [0..*] Role (DSET<II>) |
Design Comments: This is the id of the entity in the group. Note that the scoper of this role is not necessarily the issuer of the id (although it may be). |
||||||||
| code [0..1] Role (CD) {CWE:D:MemberRoleType} |
Design Comments: A role type that is used to further qualify an entity playing the role of a member of a group. |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: The administrative status of the entities membership in a group. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: The interval of time during which the entity is/was a member of a group. |
||||||||
| groupChoice [0..1] (GroupChoice) | |||||||||
| GroupChoice | |||||||||
| choice of E_PublicHealthOrganizationUniversal | |||||||||
| or EntityGroup |
Design Comments: A group of entities. This may be a formal or ad-hoc grouping of entities. The appropriate class code should be used for the purpose of creating an entity group. If determinerCode is INSTANCE then this is an instance of a group. If determinerCode is KIND then this is a kind of group. The group may be composed of any type of entity, there is no requirement that the group be of all the same type of entity. The Member role is used to associate the members of a group with the group. |
||||||||
| Observed |
Design Comments: A public health entity may have additional characteristics that are describe via this role and its associated observations. Design Comments: HL7: Observed is a role that associates an entity with a set of observations. The entity is the subject of the observations. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassRoot, root= "ROL"} |
|||||||||
| subjectOf [1..*] (Subject2) |
Design Comments: The public health entity is the subject of a set of observations. |
||||||||
| Subject2 |
Design Comments: The public health entity is the subject of a set of observations. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationTargetSubject, root= "SBJ"} |
|||||||||
| contextControlCode [0..1] Participation (CS) {CNE:V:ContextControl, default= "AN"} |
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 AN has been associated with this participation. |
||||||||
| observationEvent [1..1] (ObservationEvent) |
Design Comments: An observation on the associated entity to facilitate identification. This may be used to handle data like height, weight, hair color, eye color, etc. Rationale: Use case: identification of John Doe individuals , either the investigative subject, or some related individual. Use case: demographic data typically available from secondary sources, eg. from drivers license Use case: forensic data. Use case: red cow with white blaze. |
||||||||
| ObservationEvent |
Design Comments: An observation on the associated entity to facilitate identification. This may be used to handle data like height, weight, hair color, eye color, etc. Rationale: Use case: identification of John Doe individuals , either the investigative subject, or some related individual. Use case: demographic data typically available from secondary sources, eg. from drivers license Use case: forensic data. Use case: red cow with white blaze. |
||||||||
| classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
| moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"} |
|||||||||
| id [0..1] Observation (II) |
Design Comments: a unique identifier for the observation. |
||||||||
| code [1..1] Observation (CD) {CWE:D:ObservationType} |
Design Comments: a code that specifies the type of observation being reported. |
||||||||
| negationInd [0..1] Observation (BL) |
Design Comments: Used with an Observation event, it allows one to say "entity does not have blue eyes". RIM: An indicator specifying that the Act statement is a negation of the Act as described by the descriptive attributes. |
||||||||
| title [0..1] Observation (ED) |
Design Comments: A word or phrase by which the Observation may be known among people. Example: name of a research study (e.g. "Scandinavian Simvastatin Study" |
||||||||
| text [0..1] Observation (ED) |
Design Comments: a free-form text description of the observation. |
||||||||
| statusCode [0..1] Observation (CS) {CNE:V:ActStatus} |
Design Comments: code indicating the operative status of the business process, which in this case is an Observation. Rationale: may be required for appropriate interpretation of the Observation, which could be on-going. |
||||||||
| effectiveTime [0..1] Observation (QSET<TS>) |
Design Comments: The time period in which the Observation report was started and, if a point in time or a closed interval of time, in which it ended. May not be the time of the observation itself. |
||||||||
| confidentialityCode [0..*] Observation (DSET<CD>) {CWE:D:Confidentiality} |
Design Comments: A code that controls the disclosure of information about this observation event. |
||||||||
| value [1..1] Observation (ANY) {CWE:D:ObservationValue} |
Design Comments: Information derived from the observation; the observation 'result' expressed as a value. UsageNotes: The default ANY datatypes support any kind of information, from simple text to binary attachments (eg. an image file). Needs to be constrained for actual implementations and realistic limits set on the scope of its use. |
||||||||
| interpretationCode [0..*] Observation (DSET<CD>) {CWE:D:ObservationInterpretation} |
Design Comments: One or more codes specifying a rough qualitative interpretation of the observation, such as "normal", "abnormal", "below normal", "change up", "resistant", "susceptible", etc. |
||||||||
| methodCode [0..*] Observation (DSET<CD>) {CWE:D:ObservationMethod} |
Design Comments: 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 |
||||||||
| targetSiteCode [0..*] Observation (DSET<CD>) {CWE:D:ActSite} |
Design Comments: The anatomical site or system that is the focus of the observation. |
||||||||
| 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. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassRoot, root= "ROL"} |
Design Comments: Structural attribute. This can be any specialization of "role" not otherwise present in the model. A specific role class code must be selected for each instance of this class. |
||||||||
| id [1..*] (M) Role (DSET<II>) |
Design Comments: One or more identifiers issued to the focal subject by the associated assigningOrganization. Note, this is a mandatory attribute. Rationale: The primary intent of this role description is to supply supporting identifiers for the entity. |
||||||||
| code [0..1] Role (CD) {CWE:D:RoleCode} |
Design Comments: A code further defining the type of role. |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: A value specifying the state of this identifying relationship (based on the RIM Role class state-machine), for example, active, terminated, nullified |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: An interval of time specifying the period during which this identifying relationship is in effect, if such time limit is applicable and known. |
||||||||
| scopingOrganization [0..1] (E_OrganizationUniversal) | |||||||||
| ManagingEntity |
Design Comments: The ManagingEntity role class associates a playing entity which either owned by, hold by, maintained by or accessed through the scoping entity. This class is traversed from the player to the scoper. Depending upon jurisdiction or culture, there may be restrictions on what entities can act as owners, and what entities can be owned. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassManagedEntity} |
|||||||||
| id [0..1] Role (II) |
Design Comments: The id is assumed to be issued by the manager of the managed entity. The owner is the scoper of this role. |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: The status of the managed entity role. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: The time of management of the entity. |
||||||||
| scoper1 [0..1] (PublicHealthEntityChoice) | |||||||||
| ContactParty |
Design Comments: Captures contact information for a person who can provide information regarding the public health entity. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassContact, root= "CON"} |
|||||||||
| addr [0..*] Role (COLL<AD>) |
Design Comments: The mail and/or physical address associated with the person or organization playing the contact role. |
||||||||
| telecom [0..*] Role (COLL<TEL>) |
Design Comments: The phone number(s) and email address(s) by which the person or organization playing the contact role can be contacted. Rationale: needed for case followup and scheduling. |
||||||||
| contactPerson [0..1] (E_PersonUniversal) | |||||||||
| RelatedEntity |
Design Comments: A relationship that is based on mutual behavior of the public health entity and a related party. The basis of such relationship may be agreements (e.g., spouses, contract parties) or they may be de facto behavior (e.g. friends) or may be an incidental involvement with each other (e.g. parties over a dispute, siblings, children). This is a generalized relationship model that, in a message instance, must be more narrowly defined through a combination of two coded values: one, a RIM classcode to indicate the category of the social relationship (e.g. the "personal relationship" class) and two, a role code to refine the type of relationship being reported (e.g. "sibling"). Rationale: Social relationships are recorded by Public Health as precursors to contact tracing. The assumption is that a subject's associations may be indicative of interactions in which an infectious disease could be transmitted. These facts of association are distinguished from fact of interaction (involving contacts). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassMutualRelationship} |
Design Comments: A code identifying this portion of the model as describing a particular category of Role. UsageNotes: Note that the default classcode domain must be specialized in a message instance to identify the type of role being reported. |
||||||||
| id [0..1] Role (II) |
Design Comments: A unique identifier for the mutual relationship. The role id is not necessarily scoped or issued by the scoper of the role. UsageNotes: Identifier type is specific to the role class being messaged when the model in constrained at runtime. |
||||||||
| code [0..1] Role (CD) {CWE:D:MutualRelationshipRoleType} |
Design Comments: A code that more precisely defines the type of mutual relationship being reported. UsageNotes: Note that is a refinement of the classcode and drawn from a vocabulary domain appropriate to the selected category (aka class) of social relationship types. For example, if the relationship being described is that of |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: The status of the mutual relationships. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: The interval of time over which the mutual relationship exists. |
||||||||
| confidentialityCode [0..*] Role (DSET<CD>) {CWE:D:Confidentiality} |
Design Comments: A code indicating the confidentiality of the mutual relationship. |
||||||||
| relatedPublicHealthEntityChoice [1..1] (PublicHealthEntityChoice) | |||||||||
| Part |
Design Comments: An association between an entity (player) and another entity (scoper) where the playing entity is considered in a "part" of the other entity, e.g. body part. This role should be used only if other roles in the model such as MBR (member), INGR (ingredient), LOCE (located entity) or CONT (content) are not appropriate. Note the model includes a 'quantity' attribute for relationships that can be quantified as a numeric ratio. Design Comments: HL7: This role is identical to the PartOfWhole role, except that it reverses the direction of traversal. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassPart, root= "PART"} |
|||||||||
| id [0..1] Role (II) |
Design Comments: A unique identifier for the relationship between the playing the role of part and the scoping entity. Note that the scoper of the role will normally not be the issuer of the id. |
||||||||
| code [0..1] Role (CD) {CWE:D:PartRoleType} |
Design Comments: A coded value that more precisely defines the type of part. |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: A code indicating the operative state of the relationship e.g. normal, cancelled, terminated. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: An interval of time specifying the period during which the relationship is in effect, if such time limit is applicable and known. |
||||||||
| quantity [0..1] Role (RTO<PQ,PQ>) |
Design Comments: For compositional relationships between (usually) material substances: a ratio (numerator : denominator) specifying the relative quantities of the subject relative to the related entity. |
||||||||
| partPublicHealthEntityChoice [0..1] (PublicHealthEntityChoice) | |||||||||
| LocatedEntity |
Design Comments: Used to identify the physical presence of an entity (e.g. location of a person). Allows for nested-definitions of locations (e.g. place within a place within a place). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassLocatedEntity, root= "LOCE"} |
|||||||||
| id [0..1] Role (II) |
Design Comments: Allows an id for the location of an entity to be conveyed. Note that the scoper of this role is probably not the issuer of this id. |
||||||||
| code [0..1] Role (CD) {CWE:D:LocatedEntityRoleType} |
Design Comments: Identifies the type of entity location. |
||||||||
| addr [0..*] Role (COLL<AD>) |
Design Comments: The address of the entities location. |
||||||||
| telecom [0..*] Role (COLL<TEL>) |
Design Comments: The telecommunication or email address of the entities location. |
||||||||
| locatedPlace [0..1] (E_PublicHealthPlaceUniversal) | |||||||||
| subjectOf [0..*] (Subject3) |
Design Comments: Used to associate spatial coordinates with an entities location. If multiple spatial coordinates are provided, they should identify the same location. |
||||||||
| Subject3 |
Design Comments: Used to associate spatial coordinates with an entities location. If multiple spatial coordinates are provided, they should identify the same location. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationTargetSubject, root= "SBJ"} |
|||||||||
| contextControlCode [0..1] Participation (CS) {CNE:V:ContextControl, default= "AN"} |
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 AN has been associated with this participation. |
||||||||
| position [1..1] (A_SpatialCoordinateUniversal) | |||||||||
| ManagedEntity |
Design Comments: The ManagedEntity role class associates a scoping entity which either owns, holds, maintains or controls access to the playing entity. This class is traversed from the scoper to the player. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassManagedEntity} |
|||||||||
| id [0..1] Role (II) |
Design Comments: This is the id of the managed entity. The id is assumed to be issued by the managing entity (scoper). |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: This is the status of the managed entity role. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: The effective time is the interval of time during which the entity is managed. |
||||||||
| player1 [0..1] (PublicHealthEntityChoice) | |||||||||
| PublicHealthLivingSubject | |||||||||
| birthplace [0..1] (Birthplace) |
Design Comments: documents an entities place of birth. The entity must be a living subject (e.g., person or animal). |
||||||||
| placeOfDeath [0..1] (PlaceOfDeath) |
Design Comments: documents an entities place of death. The entity must be a living subject (e.g., person or animal). |
||||||||
| choice of Person |
Design Comments: A person that is of interest to public health. This person may be the subject of a case or investigation. |
||||||||
| or LivingSubject |
Design Comments: A living subject that is of interest to public health. This living subject may be the subject of a case or investigation. Living Subject is used when it is not known if the entity is a person or a non-person living subject. UsageNotes: LivingSubject.code has not been included specifically because if you have a code for a living subject, you should first be able to determine the appropriate class code (i.e., person or non-person living subject, and use the code attribute from those classes instead. |
||||||||
| or NonPersonLivingSubject |
Design Comments: A living subject, other than human being, that is of interest to public health. The non-person living subject may be the subject of a public health case or investigation. Design Comments: HL7: NonPersonLivingSubject is a non-human living subject entity. This class is used to document the simplest life form to the most complex. The only restriction is that the organism is not human. |
||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| Birthplace |
Design Comments: documents an entities place of birth. The entity must be a living subject (e.g., person or animal). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassBirthplace, root= "BIRTHPL"} |
|||||||||
| addr [0..1] Role (AD) |
Design Comments: One or more components of an address that identify the location where the living subject was born. Can be non-specific, e.g. Country only, or as detailed as allowed with supported address components e.g. street plus a dwelling number. |
||||||||
| birthplace [0..1] (E_PublicHealthPlaceUniversal) | |||||||||
| PlaceOfDeath |
Design Comments: documents an entities place of death. The entity must be a living subject (e.g., person or animal). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassPlaceOfDeath, root= "DEATHPLC"} |
|||||||||
| addr [0..1] Role (AD) |
Design Comments: One or more components of an address that identify the location where the living subject died. Can be non-specific, e.g. Country only, or as detailed as allowed with supported address components e.g. street plus a dwelling number. |
||||||||
| playingPlace [0..1] (E_PublicHealthPlaceUniversal) | |||||||||
| Person |
Design Comments: A person that is of interest to public health. This person may be the subject of a case or investigation. |
||||||||
| classCode [1..1] (M) Person (CS) {CNE:V:EntityClassPerson, root= "PSN"} |
|||||||||
| determinerCode [1..1] (M) Person (CS) {CNE:V:EntityDeterminer} |
|||||||||
| quantity [0..1] Person (PQ) |
Design Comments: The number or quantity of the Entity, with appropriate units. |
||||||||
| name [0..*] Person (COLL<PN>) |
Design Comments: A non-unique textual identifier or moniker for the Person. Examples: Proper name, nicknames, legal name. |
||||||||
| desc [0..1] Person (ED) |
Design Comments: A textual or multimedia depiction of the Person. |
||||||||
| riskCode [0..1] Person (CD) {CWE:D:EntityRisk} |
Design Comments: A value representing the type of hazard or threat associated with the Person. This attribute identifies the type of risk without specifying the level of risk. Rationale: Persons of irascible temperament may prove to be a risk to healthcare personnel. |
||||||||
| handlingCode [0..1] Person (CD) {CWE:D:EntityHandling} |
Design Comments: A value representing special handling requirements for the Person. |
||||||||
| administrativeGenderCode [0..1] Person (CD) {CWE:D:AdministrativeGender} |
Design Comments: A value representing the gender (sex) of a Living subject. Examples:female, male. This attribute does not include terms related to clinical gender. |
||||||||
| birthTime [0..1] Person (TS) |
Design Comments: A person's date and time of birth. |
||||||||
| deceasedInd [0..1] Person (BL) |
Design Comments: A simple true/false indicator. If true, signifies that the person is dead. |
||||||||
| deceasedTime [0..1] Person (TS) |
Design Comments: The date and time that a living subject's death occurred. |
||||||||
| multipleBirthInd [0..1] Person (BL) |
Design Comments: An indication as to whether the person is part of a multiple birth. |
||||||||
| multipleBirthOrderNumber [0..1] Person (INT.POS) |
Design Comments: The order in which this person was born if part of a multiple birth. |
||||||||
| organDonorInd [0..1] Person (BL) |
Design Comments: An indication that the person is a candidate to serve as an organ donor. Discussion: This attribute specifies whether an individual living subject has donated or is willing to donate an organ. |
||||||||
| maritalStatusCode [0..1] Person (CD) {CWE:D:MaritalStatus} |
Design Comments: A code representing the domestic partnership status of a person. Examples: Married, separated, divorced, widowed, common-law marriage. |
||||||||
| educationLevelCode [0..1] Person (CD) {CWE:D:EducationLevel} |
Design Comments: The highest level of education a person achieved (e.g. elementary school, high school or secondary school degree complete, college or baccalaureate degree complete). |
||||||||
| disabilityCode [0..*] Person (DSET<CD>) {CWE:D:PersonDisabilityType} |
Design Comments: A value identifying a person's disability. Examples: vision impaired, hearing impaired. |
||||||||
| livingArrangementCode [0..1] Person (CD) {CWE:D:LivingArrangement} |
Design Comments: A value specifying the housing situation of a person. Examples: Independent household, institution, nursing home, extended care facility, retirement community, etc. Rationale: Used for discharge planning, social service assessment, psychosocial evaluation. |
||||||||
| religiousAffiliationCode [0..1] Person (CD) {CWE:D:ReligiousAffiliation} |
Design Comments: A value representing the primary religious preference of this person. |
||||||||
| raceCode [0..*] Person (DSET<CD>) {CWE:D:Race} |
Design Comments: A set of values representing the races of this person |
||||||||
| ethnicGroupCode [0..*] Person (DSET<CD>) {CWE:D:Ethnicity} |
Design Comments: A set of values representing the ethnic groups of this person Design Comments: RIM: The ethnic group of the person. |
||||||||
| asEmployment [0..*] (Employment) |
Design Comments: Documents a person's role as an employee. The player of the role is the employee, the scoper is the employer. Employer is normally a person or an organization. |
||||||||
| languageCommunication [0..*] (LanguageCommunication) |
Design Comments: The language communication capabilities of Person. Examples: A patient who originally came from Mexico may have fluent language capabilities to speak, read and write in Spanish, but only rudimentary capabilities in English. A person from Russia may have the capability to communicate equally well in spoken language in Russian, Armenian or Ukrainian, but prefers to speak in Armenian. |
||||||||
| Inherits associations from PublicHealthLivingSubject | |||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| Employment |
Design Comments: Documents a person's role as an employee. The player of the role is the employee, the scoper is the employer. Employer is normally a person or an organization. |
||||||||
| classCode [1..1] (M) Employee (CS) {CNE:V:RoleClassEmployee, root= "EMP"} |
|||||||||
| id [0..1] Employee (II) |
Design Comments: Employee identifier for the focal entity in this employment relationship. |
||||||||
| code [0..1] Employee (CD) {CWE:D:EmployeeRoleType} |
Design Comments: 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 playing entity has with the institution/individual for whom he/she/it provides services. |
||||||||
| negationInd [0..1] Employee (BL) |
Design Comments: An Employee with negationInd "true" and an EmployerChoice of "not applicable" null flavor conveys that the focal person is recorded as "not employed" |
||||||||
| addr [0..*] Employee (COLL<AD>) |
Design Comments: The focal entities work address(es) for this employment relationship (addr.use = WP) |
||||||||
| telecom [0..*] Employee (COLL<TEL>) |
Design Comments: The focal entities work telecommunications address(es) for this employment relationship (telecom.use = WP) |
||||||||
| statusCode [0..1] Employee (CS) {CNE:V:RoleStatus} |
Design Comments: A value specifying the state of this employment relationship (based on the RIM Role class state-machine), for example, active, suspended, terminated |
||||||||
| effectiveTime [0..1] Employee (IVL<TS>) |
Design Comments: An interval of time specifying the period during which this employment relationship is in effect, if such time limit is applicable and known. |
||||||||
| jobCode [0..1] Employee (CD) {CWE:D:EmployeeJob} |
Design Comments: A code specifying the job performed by the employee for the employer. For example, accountant, programmer analyst, patient care associate, staff nurse, etc. |
||||||||
| jobTitleName [0..1] Employee (SC) {CWE:D:JobTitleName} |
Design Comments: The title of the job held, for example, Vice President, Senior Technical Analyst. This is a local name for the employee's occupation that does not necessarily correspond to any scheme for categorizing occupation. Trading partners that need a coded standard should be using Employee "occupation" attribute. |
||||||||
| jobClassCode [0..1] Employee (CD) {CWE:D:EmployeeJobClass} |
Design Comments: A code qualifying the employment regarding frequency or periodicity, such as, full-time vs. part-time |
||||||||
| occupationCode [0..1] Employee (CD) {CWE:D:EmployeeOccupationCode} |
Design Comments: A code qualifying the classification of kind-of-work based upon a recognized industry or jurisdictional standard. OccupationCode is used to convey the person's occupation as opposed to jobCode which characterizes this particular job. |
||||||||
| hazardExposureText [0..1] Employee (ED) |
Design Comments: RIM: The type of hazards associated with the work performed by the employee for the employer. For example, asbestos, infectious agents. |
||||||||
| protectiveEquipmentText [0..1] Employee (ED) |
Design Comments: RIM: Protective equipment needed for the job performed by the employee for the employer. For example, safety glasses, hardhat. |
||||||||
| employerChoice [0..1] (EmployerChoice) | |||||||||
| EmployerChoice | |||||||||
| choice of E_PublicHealthPersonUniversal | |||||||||
| or E_PublicHealthOrganizationUniversal | |||||||||
| LanguageCommunication |
Design Comments: The language communication capabilities of Person. Examples: A patient who originally came from Mexico may have fluent language capabilities to speak, read and write in Spanish, but only rudimentary capabilities in English. A person from Russia may have the capability to communicate equally well in spoken language in Russian, Armenian or Ukrainian, but prefers to speak in Armenian. |
||||||||
| languageCode [1..1] (M) LanguageCommunication (CD) {CWE:D:HumanLanguage} |
Design Comments: RIM: A value representing a language for which the Person some level of proficiency for written or spoken communication. |
||||||||
| modeCode [0..1] LanguageCommunication (CD) {CWE:D:LanguageAbilityMode} |
Design Comments: A value representing the method of expression of the language. Examples: expressed spoken, expressed written, expressed signed, received spoken, received written, received signed. |
||||||||
| proficiencyLevelCode [0..1] LanguageCommunication (CD) {CWE:D:LanguageAbilityProficiency} |
Design Comments: A value representing the person's level of proficiency in a language. |
||||||||
| preferenceInd [0..1] LanguageCommunication (BL) |
Design Comments: An indicator specifying whether or not the language is preferred by the person for the associated mode. |
||||||||
| LivingSubject |
Design Comments: A living subject that is of interest to public health. This living subject may be the subject of a case or investigation. Living Subject is used when it is not known if the entity is a person or a non-person living subject. UsageNotes: LivingSubject.code has not been included specifically because if you have a code for a living subject, you should first be able to determine the appropriate class code (i.e., person or non-person living subject, and use the code attribute from those classes instead. |
||||||||
| classCode [1..1] (M) LivingSubject (CS) {CNE:V:EntityClassLivingSubject, root= "LIV"} |
|||||||||
| determinerCode [1..1] (M) LivingSubject (CS) {CNE:V:EntityDeterminer} |
|||||||||
| quantity [0..1] LivingSubject (PQ) |
Design Comments: The number or quantity of the Entity, with appropriate units. |
||||||||
| name [0..*] LivingSubject (COLL<EN>) |
Design Comments: A non-unique textual identifier or moniker for the living subject. |
||||||||
| desc [0..1] LivingSubject (ED) |
Design Comments: A textual or multimedia depiction of the living subject. |
||||||||
| existenceTime [0..1] LivingSubject (IVL<TS>) |
Design Comments: An interval of time specifying the period in which the living subject physically existed. |
||||||||
| riskCode [0..*] LivingSubject (DSET<CD>) {CWE:D:EntityRisk} |
Design Comments: A value representing the type of hazard or threat associated with the living subject. This attribute identifies the type of risk without specifying the level of risk. |
||||||||
| handlingCode [0..*] LivingSubject (DSET<CD>) {CWE:D:EntityHandling} |
Design Comments: A value representing special handling requirements for the living subject |
||||||||
| administrativeGenderCode [0..1] LivingSubject (CD) {CWE:D:AdministrativeGender} |
Design Comments: A value representing the gender (sex) of a Living subject. Examples:female, male. |
||||||||
| birthTime [0..1] LivingSubject (TS) |
Design Comments: The living subjects date and time of birth. |
||||||||
| deceasedInd [0..1] LivingSubject (BL) |
Design Comments: A simple true/false indicator. If true, signifies that the living subject is dead. |
||||||||
| deceasedTime [0..1] LivingSubject (TS) |
Design Comments: The date and time that the living subject's death occurred. |
||||||||
| multipleBirthInd [0..1] LivingSubject (BL) |
Design Comments: An indication as to whether the living subject is part of a multiple birth. |
||||||||
| multipleBirthOrderNumber [0..1] LivingSubject (INT.POS) |
Design Comments: The order in which this living was born if part of a multiple birth. |
||||||||
| organDonorInd [0..1] LivingSubject (BL) |
Design Comments: An indication that the living subject is a candidate to serve as an organ donor. Discussion: This attribute specifies whether an individual living subject has donated or is willing to donate an organ. |
||||||||
| Inherits associations from PublicHealthLivingSubject | |||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| NonPersonLivingSubject |
Design Comments: A living subject, other than human being, that is of interest to public health. The non-person living subject may be the subject of a public health case or investigation. Design Comments: HL7: NonPersonLivingSubject is a non-human living subject entity. This class is used to document the simplest life form to the most complex. The only restriction is that the organism is not human. |
||||||||
| classCode [1..1] (M) NonPersonLivingSubject (CS) {CNE:V:EntityClassNonPersonLivingSubject, root= "NLIV"} |
|||||||||
| determinerCode [1..1] (M) NonPersonLivingSubject (CS) {CNE:V:EntityDeterminer} |
|||||||||
| code [0..1] NonPersonLivingSubject (CD) {CWE:D:NonPersonLivingSubjectEntityType} |
Design Comments: A code identifying the type of organism being described. |
||||||||
| quantity [0..1] NonPersonLivingSubject (PQ) |
Design Comments: The number or quantity of the Entity, with appropriate units. |
||||||||
| name [0..*] NonPersonLivingSubject (COLL<TN>) |
Design Comments: A non-unique textual identifier or moniker for the organism |
||||||||
| desc [0..1] NonPersonLivingSubject (ED) |
Design Comments: A textual or multimedia depiction of the organism |
||||||||
| existenceTime [0..1] NonPersonLivingSubject (IVL<TS>) |
Design Comments: An interval of time specifying the period in which the organism physically existed. |
||||||||
| riskCode [0..1] NonPersonLivingSubject (CD) {CWE:D:EntityRisk} |
Design Comments: A value representing the type of hazard or threat associated with the organism. This attribute identifies the type of risk without specifying the level of risk. |
||||||||
| handlingCode [0..1] NonPersonLivingSubject (CD) {CWE:D:EntityHandling} |
Design Comments: A value representing special handling requirements for the organism |
||||||||
| administrativeGenderCode [0..1] NonPersonLivingSubject (CD) {CWE:D:AdministrativeGender} |
Design Comments: A value representing the gender (sex) of a Living subject. Examples:female, male. |
||||||||
| birthTime [0..1] NonPersonLivingSubject (TS) |
Design Comments: The organisms date and time of birth; typically only used when describing animals. |
||||||||
| deceasedInd [0..1] NonPersonLivingSubject (BL) |
Design Comments: A simple true/false indicator. If true, signifies that the subject is dead. |
||||||||
| deceasedTime [0..1] NonPersonLivingSubject (TS) |
Design Comments: The date and time that the living subject's death occurred. |
||||||||
| multipleBirthInd [0..1] NonPersonLivingSubject (BL) |
Design Comments: An indication as to whether the organism is part of a multiple birth. |
||||||||
| multipleBirthOrderNumber [0..1] NonPersonLivingSubject (INT.POS) |
Design Comments: The order in which this organism was born if part of a multiple birth. |
||||||||
| organDonorInd [0..1] NonPersonLivingSubject (BL) |
Design Comments: An indication that the organism is a candidate to serve as an organ donor. Discussion: This attribute specifies whether an individual living subject has donated or is willing to donate an organ. |
||||||||
| strainText [0..1] NonPersonLivingSubject (ED) |
Design Comments: A text string representing a specific genotypic or phenotypic variant of an organism. |
||||||||
| genderStatusCode [0..1] NonPersonLivingSubject (CD) {CWE:D:GenderStatus} |
Design Comments: A value representing whether the primary reproductive organs of an organism are present. |
||||||||
| asProductEntity [0..*] (ProductEntity) |
Design Comments: The ProductEntity class is used to associate a product (player) with the organization (scopes) that distributes, retails, manufactures, regulates or warrants the product. |
||||||||
| Inherits associations from PublicHealthLivingSubject | |||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| ProductEntity |
Design Comments: The ProductEntity class is used to associate a product (player) with the organization (scopes) that distributes, retails, manufactures, regulates or warrants the product. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassProductRelated} |
|||||||||
| id [0..1] Role (II) |
Design Comments: A unique identifier for the relationship between the entity playing the role of product and the organization scoping the role. The scoping organization is assumed to be the issuer of the id. |
||||||||
| code [0..1] Role (CD) {CWE:D:ProductRelatedRoleType} |
Design Comments: A code further identifying the type of product. |
||||||||
| name [0..1] Role (TN) |
Design Comments: The name of the product. |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: A code indicating the operative state of the relationship e.g. normal, cancelled, terminated. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: An interval of time specifying the period during which the relationship is in effect, if such time limit is applicable and known. |
||||||||
| scoper [0..1] (E_PublicHealthOrganizationUniversal) | |||||||||
| PublicHealthPlaceOrMaterialChoice | |||||||||
| choice of Place |
Design Comments: A place that is of interest to public health. The place may be the subject of a public health case or investigation. More: 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. Design Comments: HL7: Place is an entity that documents a location. Note that the mobileInd has been included to handle vehicles which can be considered as places that move. Place does have a playing association to a manufactured product role to convey aspects of a vehicle that are more properly a material. |
||||||||
| or PublicHealthMaterialSubject | |||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| Place |
Design Comments: A place that is of interest to public health. The place may be the subject of a public health case or investigation. More: 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. Design Comments: HL7: Place is an entity that documents a location. Note that the mobileInd has been included to handle vehicles which can be considered as places that move. Place does have a playing association to a manufactured product role to convey aspects of a vehicle that are more properly a material. |
||||||||
| classCode [1..1] (M) Place (CS) {CNE:V:EntityClassPlace, root= "PLC"} |
|||||||||
| determinerCode [1..1] (M) Place (CS) {CNE:V:EntityDeterminer} |
|||||||||
| code [0..1] Place (CD) {CWE:D:PlaceEntityType} |
Design Comments: A coded value that further identifies the type of place or location. |
||||||||
| quantity [0..1] Place (PQ) |
Design Comments: The number or quantity of the Entity, with appropriate units. |
||||||||
| name [0..*] Place (COLL<EN>) |
Design Comments: A non-unique textual identifier or moniker for the place. |
||||||||
| desc [0..1] Place (ED) |
Design Comments: A textual or multi-media depiction of the place. |
||||||||
| existenceTime [0..1] Place (IVL<TS>) |
Design Comments: An interval of time specifying the period in which the place physically existed. Rationale: The relevance of this attribute is in planning, availability and retrospective analysis. |
||||||||
| riskCode [0..1] Place (CD) {CWE:D:EntityRisk} |
Design Comments: A value representing the type of hazard or threat associated with the Place. The place may be contaminated with a hazardous substance, organism, radioactivity or other harmful substance. The place may be a dangerous location in the first place, such as the top of Mount Everest. |
||||||||
| handlingCode [0..1] Place (CD) {CWE:D:EntityHandling} |
Design Comments: A value representing special handling requirements for the place. Since places may be mobile, they may need special handling. Rationale: This attribute is used to describe special handling required by the Entity to avoid damage to it or other entities. |
||||||||
| mobileInd [0..1] Place (BL) |
Design Comments: RIM: An Indication of whether the facility has the capability to move freely from one location to another. Examples:Ships, aircraft and ambulances all have the capability to participate in healthcare acts. |
||||||||
| directionsText [0..1] Place (ED) |
Design Comments: A free text note that carries information about locating or accessing the place. UsageNotes: The default ED datatype supports both free text entries as well as binary attachments. Probably needs to be constrained to simpler datatype unless this full range of functionality is required. |
||||||||
| asTerritorialAuthority [0..*] (TerritorialAuthority) |
Design Comments: Relates a place entity (player) as the region over which the scoper (typically an Organization) has certain authority (jurisdiction). |
||||||||
| asLocatedPlacePartOf [0..*] (LocatedPlacePartOf) |
Design Comments: An association of a place to other places that contain it. This supports a hierarchy of places, for example a bed location (playing entity) located within a room (scoping entity) |
||||||||
| asProductEntity [0..*] (ProductEntity) | |||||||||
| locatedPlaceHasParts [0..*] (LocatedPlaceHasParts) |
Design Comments: An association of a place to other places contained within it. This supports a hierarchy of places, for example a building wing (scoping entity) contains rooms (playing entity). |
||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| TerritorialAuthority |
Design Comments: Relates a place entity (player) as the region over which the scoper (typically an Organization) has certain authority (jurisdiction). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassTerritoryOfAuthority, root= "TERR"} |
|||||||||
| code [0..1] Role (CD) {CWE:D:TerritorialAuthorityRoleType} |
Design Comments: A code further identifying the type of territorial authority or jurisdiction. |
||||||||
| governingOrganization [1..1] (E_PublicHealthOrganizationUniversal) | |||||||||
| LocatedPlacePartOf |
Design Comments: An association of a place to other places that contain it. This supports a hierarchy of places, for example a bed location (playing entity) located within a room (scoping entity) |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassLocatedEntity, root= "LOCE"} |
|||||||||
| id [0..*] Role (DSET<II>) |
Design Comments: Identifier(s) for this hierarchical relationship of two places. |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: This is the status of the association between the playing and scoping places. This becomes important for mobile locations. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: This is the interval of time the places are associated. |
||||||||
| location [0..1] (Place) | |||||||||
| LocatedPlaceHasParts |
Design Comments: An association of a place to other places contained within it. This supports a hierarchy of places, for example a building wing (scoping entity) contains rooms (playing entity). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassLocatedEntity, root= "LOCE"} |
|||||||||
| id [0..1] Role (II) |
Design Comments: Identifier(s) for this hierarchical relationship of a place containing another place |
||||||||
| statusCode [0..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: This is the status of the association between the playing and scoping places. This becomes important for mobile locations. |
||||||||
| effectiveTime [0..1] Role (IVL<TS>) |
Design Comments: This is the interval of time the places are associated. |
||||||||
| locatedPlace [0..1] (Place) | |||||||||
| PublicHealthMaterialSubject | |||||||||
| asIngredient [0..*] (Ingredient) |
Design Comments: RIM: Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube. Note that the INGR class code has a number of specializations including: IACT - inactive ingredient COLR - color additive FLVR - flavor ingredient PRSV - preservative STBL - stabilizer ACTI - active ingredient ACTM - active moiety ADTV - additive BASE - base Use the most appropriate class code which describes the relationship between the component (player) and the mixture (scoper). |
||||||||
| hasIngredients [0..*] (HasIngredients) |
Design Comments: RIM: Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube. Note that the INGR class code has a number of specializations including: IACT - inactive ingredient COLR - color additive FLVR - flavor ingredient PRSV - preservative STBL - stabilizer ACTI - active ingredient ACTM - active moiety ADTV - additive BASE - base Use the most appropriate class code which describes the relationship between the component (player) and the mixture (scoper). |
||||||||
| choice of Material |
Design Comments: A non-living substance that is of interest to public health. The substance may be the subject of a public health case or investigation. Note that manufactured materials are described elsewhere in the model. Design Comments: RIM: Any thing that has extension in space and mass, may be of living or non-living origin. |
||||||||
| or ManufacturedMaterial |
Design Comments: Any sort of artificial material, typically a manufactured item, that is of interest to public health. The artificial material may be the subject of a public health case or investigation. |
||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| Ingredient |
Design Comments: RIM: Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube. Note that the INGR class code has a number of specializations including: IACT - inactive ingredient COLR - color additive FLVR - flavor ingredient PRSV - preservative STBL - stabilizer ACTI - active ingredient ACTM - active moiety ADTV - additive BASE - base Use the most appropriate class code which describes the relationship between the component (player) and the mixture (scoper). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassIngredientEntity, root= "INGR"} |
|||||||||
| negationInd [0..1] Role (BL) |
Design Comments: Used to indicate the mixture does not contain this ingredient. |
||||||||
| confidentialityCode [0..*] Role (DSET<CD>) {CWE:D:Confidentiality} |
Design Comments: Used to indicate that the manufacturer considers the presence of the ingredient a trade secret. |
||||||||
| quantity [0..1] Role (RTO<PQ,PQ>) |
Design Comments: If the ingredient is unknown in quantity, leave the quantity as null. Where it is a "trace" use "trace" form of null. Where the quantity is to be adjusted to achieve a final value use "qs" flavor of null. |
||||||||
| ingredientOfPublicHealthMaterialSubject [0..1] (PublicHealthMaterialSubject) | |||||||||
| HasIngredients |
Design Comments: RIM: Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube. Note that the INGR class code has a number of specializations including: IACT - inactive ingredient COLR - color additive FLVR - flavor ingredient PRSV - preservative STBL - stabilizer ACTI - active ingredient ACTM - active moiety ADTV - additive BASE - base Use the most appropriate class code which describes the relationship between the component (player) and the mixture (scoper). |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassIngredientEntity, root= "INGR"} |
|||||||||
| negationInd [0..1] Role (BL) |
Design Comments: Used to indicate the mixture does not contain this ingredient. |
||||||||
| confidentialityCode [0..*] Role (DSET<CD>) {CWE:D:Confidentiality} |
Design Comments: Used to indicate that the manufacturer considers the presence of the ingredient a trade secret. |
||||||||
| quantity [0..1] Role (RTO<PQ,PQ>) |
Design Comments: If the ingredient is unknown in quantity, leave the quantity as null. Where it is a "trace" use "trace" form of null. Where the quantity is to be adjusted to achieve a final value use "qs" flavor of null. |
||||||||
| ingredientPublicHealthMaterialSubject [0..1] (PublicHealthMaterialSubject) | |||||||||
| Material |
Design Comments: A non-living substance that is of interest to public health. The substance may be the subject of a public health case or investigation. Note that manufactured materials are described elsewhere in the model. Design Comments: RIM: Any thing that has extension in space and mass, may be of living or non-living origin. |
||||||||
| classCode [1..1] (M) Material (CS) {CNE:V:EntityClassMaterial, root= "MAT"} |
|||||||||
| determinerCode [1..1] (M) Material (CS) {CNE:V:EntityDeterminer} |
|||||||||
| id [0..1] Material (II) |
Design Comments: A unique identifier for the substance. The id attribute is used when ther material item has an identifier directly associated with it. Examples include serial numbers for manufactured items or a bar code on a specimen container. |
||||||||
| code [0..1] Material (CD) {CWE:D:MaterialEntityClassType} |
Design Comments: A coded value the specifies the type of substance being described. |
||||||||
| quantity [0..1] Material (PQ) |
Design Comments: The number or quantity of the substance, with appropriate units. |
||||||||
| name [0..*] Material (COLL<TN>) |
Design Comments: A non-unique textual identifier or moniker for the substance |
||||||||
| desc [0..1] Material (ED) |
Design Comments: A textual or multimedia depiction of the substance |
||||||||
| existenceTime [0..1] Material (IVL<TS>) |
Design Comments: An interval of time specifying the period in which the substance physically existed. |
||||||||
| riskCode [0..1] Material (CD) {CWE:D:EntityRisk} |
Design Comments: RIM: A value representing the type of hazard or threat associated with the Entity. |
||||||||
| handlingCode [0..1] Material (CD) {CWE:D:EntityHandling} |
Design Comments: This attribute is used to describe special handling required by the substance to avoid damage to it or other entities. |
||||||||
| formCode [0..1] Material (CD) {CWE:D:MaterialForm} |
Design Comments: A value representing the state (solid, liquid, gas) and nature of the material. |
||||||||
| asProductEntity [0..*] (ProductEntity) | |||||||||
| Inherits associations from PublicHealthMaterialSubject | |||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| ManufacturedMaterial |
Design Comments: Any sort of artificial material, typically a manufactured item, that is of interest to public health. The artificial material may be the subject of a public health case or investigation. |
||||||||
| classCode [1..1] (M) ManufacturedMaterial (CS) {CNE:V:EntityClassManufacturedMaterial, root= "MMAT"} |
|||||||||
| determinerCode [1..1] (M) ManufacturedMaterial (CS) {CNE:V:EntityDeterminer} |
|||||||||
| id [0..1] ManufacturedMaterial (II) |
Design Comments: A unique identifier for the manufactured material. Note that this identifies a specific instance of a manufactured product and is therefore used to communicate an identifier such as a serial number. The id attribute is used when ther material item has an identifier directly associated with it. Examples include serial numbers for manufactured items or a bar code on a specimen container. |
||||||||
| code [0..1] ManufacturedMaterial (CD) {CWE:D:MaterialEntityClassType} |
Design Comments: A coded value the specifies the type of manufactured material being described. |
||||||||
| quantity [0..1] ManufacturedMaterial (PQ) |
Design Comments: The number or quantity of the manufactured material, with appropriate units. |
||||||||
| name [0..*] ManufacturedMaterial (COLL<EN>) |
Design Comments: A non-unique textual identifier or moniker for the manufactured substance |
||||||||
| desc [0..1] ManufacturedMaterial (ED) |
Design Comments: A textual or multimedia depiction of the manufactured material |
||||||||
| existenceTime [0..1] ManufacturedMaterial (IVL<TS>) |
Design Comments: An interval of time specifying the period in which the manufactured material physically existed. |
||||||||
| riskCode [0..1] ManufacturedMaterial (CD) {CWE:D:EntityRisk} |
Design Comments: RIM: A value representing the type of hazard or threat associated with the manufactured material. |
||||||||
| handlingCode [0..1] ManufacturedMaterial (CD) {CWE:D:EntityHandling} |
Design Comments: This attribute is used to describe special handling required by the material to avoid damage to it or other entities. |
||||||||
| formCode [0..1] ManufacturedMaterial (CD) {CWE:D:MaterialForm} |
Design Comments: A value representing the state (solid, liquid, gas) and nature of the manufactured material. |
||||||||
| lotNumberText [0..1] ManufacturedMaterial (ST.SIMPLE) |
Design Comments: An alphanumeric string used to identify a particular batch of manufactured material. Discussion: The lot name is usually printed on the label attached to the container holding the substance and/or on the packaging which houses the container. Note that a lot number is not meant to be a unique identifier, but is meaningful only when the product kind and manufacturer are also identified. |
||||||||
| expirationTime [0..1] ManufacturedMaterial (IVL<TS>) |
Design Comments: RIM: The date and time the manufacturer no longer ensures the safety, quality, and/or proper functioning of the material. |
||||||||
| stabilityTime [0..1] ManufacturedMaterial (IVL<TS>) |
Design Comments: RIM: The time at which the material is considered useable after it is activated. |
||||||||
| asProductEntity [0..*] (ProductEntity) | |||||||||
| containedEntity [0..*] (ContainedEntity) |
Design Comments: ContainedEntity associates a container (scoper) with its content (player). This role is traversed from scoper to player. |
||||||||
| Inherits associations from PublicHealthMaterialSubject | |||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||
| ContainedEntity |
Design Comments: ContainedEntity associates a container (scoper) with its content (player). This role is traversed from scoper to player. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassContent, root= "CONT"} |
|||||||||
| contained1 [1..1] (EntityContentChoice) | |||||||||
| EntityContentChoice | |||||||||
| asEntityInContainer [0..*] (EntityInContainer) |
Design Comments: EntityInContainer associates the content (player) with a container (scoper). This role is traversed from player to scoper. |
||||||||
| choice of Person |
Design Comments: A person that is of interest to public health. This person may be the subject of a case or investigation. |
||||||||
| or NonPersonLivingSubject |
Design Comments: A living subject, other than human being, that is of interest to public health. The non-person living subject may be the subject of a public health case or investigation. Design Comments: HL7: NonPersonLivingSubject is a non-human living subject entity. This class is used to document the simplest life form to the most complex. The only restriction is that the organism is not human. |
||||||||
| or LivingSubject |
Design Comments: A living subject that is of interest to public health. This living subject may be the subject of a case or investigation. Living Subject is used when it is not known if the entity is a person or a non-person living subject. UsageNotes: LivingSubject.code has not been included specifically because if you have a code for a living subject, you should first be able to determine the appropriate class code (i.e., person or non-person living subject, and use the code attribute from those classes instead. |
||||||||
| or Material |
Design Comments: A non-living substance that is of interest to public health. The substance may be the subject of a public health case or investigation. Note that manufactured materials are described elsewhere in the model. Design Comments: RIM: Any thing that has extension in space and mass, may be of living or non-living origin. |
||||||||
| or ManufacturedMaterial |
Design Comments: Any sort of artificial material, typically a manufactured item, that is of interest to public health. The artificial material may be the subject of a public health case or investigation. |
||||||||
| or Entity |
Design Comments: An entity of interest to public health. The Entity class should only be used when the entity is not better represented by one of the other choices in the PublicHealthEntityChoice. |
||||||||
| EntityInContainer |
Design Comments: EntityInContainer associates the content (player) with a container (scoper). This role is traversed from player to scoper. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassContent, root= "CONT"} |
|||||||||
| containerManufacturedMaterial [1..1] (ManufacturedMaterial) | |||||||||
| Entity |
Design Comments: An entity of interest to public health. The Entity class should only be used when the entity is not better represented by one of the other choices in the PublicHealthEntityChoice. |
||||||||
| classCode [1..1] (M) Entity (CS) {CNE:V:EntityClassRoot, root= "ENT"} |
|||||||||
| determinerCode [1..1] (M) Entity (CS) {CNE:V:EntityDeterminerSpecific, root= "INSTANCE"} |
|||||||||
| code [0..1] Entity (CD) {CWE:D:EntityCode} |
Design Comments: A code further describing the type of entity. |
||||||||
| quantity [0..1] Entity (PQ) |
Design Comments: The number or quantity of the Entity, with appropriate units. |
||||||||
| name [0..1] Entity (ST) |
Design Comments: A non-unique textual identifier or moniker for the entity. |
||||||||
| desc [0..1] Entity (ED) |
Design Comments: A textual or multimedia depiction of the entity. |
||||||||
| statusCode [0..1] Entity (CS) {CNE:V:EntityStatus} |
Design Comments: A code indicating the status of the record of this entity. |
||||||||
| existenceTime [0..1] Entity (IVL<TS>) |
Design Comments: An interval of time specifying the period in which the entity physically existed. |
||||||||
| riskCode [0..*] Entity (DSET<CD>) {CWE:D:EntityRisk} |
Design Comments: A value representing the type of hazard or threat associated with the organism. This attribute identifies the type of risk without specifying the level of risk. |
||||||||
| handlingCode [0..*] Entity (DSET<CD>) {CWE:D:EntityHandling} |
Design Comments: A value representing special handling requirements for the entity. |
||||||||
| Inherits associations from EntityContentChoice | |||||||||
| EntityGroup |
Design Comments: A group of entities. This may be a formal or ad-hoc grouping of entities. The appropriate class code should be used for the purpose of creating an entity group. If determinerCode is INSTANCE then this is an instance of a group. If determinerCode is KIND then this is a kind of group. The group may be composed of any type of entity, there is no requirement that the group be of all the same type of entity. The Member role is used to associate the members of a group with the group. |
||||||||
| classCode [1..1] (M) Entity (CS) {CNE:V:EntityClassRoot, root= "ENT"} |
|||||||||
| determinerCode [1..1] (M) Entity (CS) {CNE:V:EntityDeterminer} |
|||||||||
| code [0..1] Entity (CD) {CWE:D:EntityCode} |
Design Comments: A code further describing the type of group. |
||||||||
| quantity [0..1] Entity (INT) |
Design Comments: The number of entities in the group. |
||||||||
| name [0..1] Entity (ST) |
Design Comments: A non-unique textual identifier or moniker for the entity group. |
||||||||
| desc [0..1] Entity (ED) |
Design Comments: A textual or multimedia depiction of the entity group. |
||||||||
| statusCode [0..1] Entity (CS) {CNE:V:EntityStatus} |
Design Comments: A code indicating the status of the record of this entity group. |
||||||||
| existenceTime [0..1] Entity (IVL<TS>) |
Design Comments: An interval of time specifying the period in which the entity kind physically group. |
||||||||
| riskCode [0..*] Entity (DSET<CD>) {CWE:D:EntityRisk} |
Design Comments: A value representing the type of hazard or threat associated with the entity group. This attribute identifies the type of risk without specifying the level of risk. |
||||||||
| handlingCode [0..*] Entity (DSET<CD>) {CWE:D:EntityHandling} |
Design Comments: A value representing special handling requirements for the entity group. |
||||||||
| Inherits associations from PublicHealthEntityChoice | |||||||||