This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

V3\HL7DefinedRoseProperty\v3-HL7DefinedRoseProperty.json

The property Ids that HL7 has defined for customizing Rational Rose. Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used.

{
  "resourceType": "ValueSet",
  "text": {
    "status": "generated",
    "div": "<div><p>Release Date: 2014-08-07</p>\r\n<h2>Description</h2>\r\n<p>\n                  The property Ids that HL7 has defined for customizing Rational Rose.<br/>\r\n\n                  \n                     Deprecation Comment: Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used.<br/>\r\n\n               </p>\r\n<hr/>\r\n<table class=\"grid\">\r\n <tr><td><b>Level</b></td><td><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr>\r\n <tr><td>1</td><td>ApplicationRoleI<a name=\"ApplicationRoleI\"> </a></td><td>Application Role</td><td>\n                        Holds the unique identifier of an Application Role (stereotype of class).<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>Cardinality<a name=\"Cardinality\"> </a></td><td>Attribute Cardinality</td><td>\n                        Records the constraints on the cardinality of attributes as documented in the RIM and in MIMs.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>DeleteFromMIM<a name=\"DeleteFromMIM\"> </a></td><td>MIM Delete</td><td>\n                        Used in constructing a Message Information Model to indicate which attributes to omit from the MIM.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>DevelopingCommit<a name=\"DevelopingCommit\"> </a></td><td>Developing committee</td><td>\n                        Holds the id of the HL7 committee developing the model like &quot;C00.&quot;<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>DTsymbol<a name=\"DTsymbol\"> </a></td><td>Data type symbol</td><td>\n                        Holds the symbol for a defined data type (stereotype of class).<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>EndState<a name=\"EndState\"> </a></td><td>End state</td><td>\n                        The HL7 MDF says that leaf level use cases should be connected to a state transition of the subject class.  The use case diagram provides the link to the subject class.  The modeler must use three properties to identify the state transition -- this property and the two following ones named StartState and StateTransition.  The first two are, as their names imply, the names of the starting state and ending state of the transition, and the third is the name of the transition.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>HMD<a name=\"HMD\"> </a></td><td>HMD identifier</td><td>\n                        The identifier of the HMD from which the message structure for the message transferred by an interaction is drawn.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>ID<a name=\"ID\"> </a></td><td>Identifier</td><td>\n                        Holds the unique identifier of use cases, interactions and storyboards.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>InstancedDTsymbo<a name=\"InstancedDTsymbo\"> </a></td><td>Data type instantiated</td><td>\n                        Holds the data type assigned to the generic type parameter when an instantiation of generic type is recorded.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>IsPrimitiveDT<a name=\"IsPrimitiveDT\"> </a></td><td>Primitive data type</td><td>\n                        Indicates that a data type definition is for a primitive data type (stereotype of class).<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>IsReferenceDT<a name=\"IsReferenceDT\"> </a></td><td>Reference data type</td><td>\n                        Indicates that the type for a data type component (attribute of a data type stereotype of class) is found by reference.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>IsSubjectClass<a name=\"IsSubjectClass\"> </a></td><td>Subject class</td><td>\n                        Set true for classes that are subject classes.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>MandatoryInclusi<a name=\"MandatoryInclusi\"> </a></td><td>Mandatory</td><td>\n                        Indicates with a value of &quot;True&quot; whether the inclusion of an attribute in an HMD and in the messages derived from that HMD is mandatory.  The default is not mandatory, and use of mandatory inclusion in the RIM is deprecated.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>MayRepeat<a name=\"MayRepeat\"> </a></td><td>Attribute may repeat</td><td>\n                        Indicates with values of &quot;True&quot; or &quot;False&quot; whether an attribute may repeat in an HMD.  The default is non-repeating.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>MIM_id<a name=\"MIM_id\"> </a></td><td>MIM Identifier</td><td>\n                        Used in a subject area category that holds a MIM.  It provides the unique identifier for the MIM.  The first portion of this identifier should be the ModelID of the RIM from which the MIM is derived.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>ModelDate<a name=\"ModelDate\"> </a></td><td>Model date</td><td>\n                        A text version of the last modified date formatted like &quot;19970606&quot;<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>ModelDescription<a name=\"ModelDescription\"> </a></td><td>Model description</td><td>\n                        Contains the textual description of the model.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>ModelID<a name=\"ModelID\"> </a></td><td>Model identifier</td><td>\n                        Holds the unique identifier assigned to this model.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>ModelName<a name=\"ModelName\"> </a></td><td>Model name</td><td>\n                        Holds the formal name for the model<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>ModelVersion<a name=\"ModelVersion\"> </a></td><td>Model version</td><td>\n                        A text version of the version number like &quot;V 30-08&quot;<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>MsgID<a name=\"MsgID\"> </a></td><td>Message type identifier</td><td>\n                        The identifier of the message structure within the HMD (above) that defines the message transferred by an interaction.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>Organization<a name=\"Organization\"> </a></td><td>Developing organization</td><td>\n                        This is the organization defining the model, &quot;Health_Level_Seven&quot;<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>RcvResp<a name=\"RcvResp\"> </a></td><td>Receiver responsibility</td><td>\n                        This property holds the identifier of the follow-on interaction, when the receiving application role for an interaction has the responsibility to initiate a follow-on interaction.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>RespComm_id<a name=\"RespComm_id\"> </a></td><td>Responsible committee ID</td><td>\n                        Captures the identifier of the responsible committee for all subject areas and categories.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>StartState<a name=\"StartState\"> </a></td><td>Start state</td><td>\n                        (See description of EndState above).<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>StateAttribute<a name=\"StateAttribute\"> </a></td><td>State attribute</td><td>\n                        For classes that are subject classes, this component provides the name of the state attribute for the class.  Only one state attribute component may appear for a given class.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>StateTransition<a name=\"StateTransition\"> </a></td><td>State transition</td><td>\n                        (See description of EndState above.)<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>V23_Datatype<a name=\"V23_Datatype\"> </a></td><td>Version 2 data type</td><td>\n                        This component can document the Version 2.3 datatype for an attribute that is related to or derived from data fields in HL7 Version 2.3.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>V23_Fields<a name=\"V23_Fields\"> </a></td><td>Version 2 Field reference</td><td>\n                        This component provides a reference to the source Version 2.x field for an attribute that is related to or derived from data fields in HL7 Version 2.3 standard.  Concatenate multiple values with commas, if multiple references to Version 2.x exist for an attribute.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>Vocab_domain<a name=\"Vocab_domain\"> </a></td><td>Vocabulary domain</td><td>\n                        Captures the identifier (name) of the vocabulary domain that constrains the values of coded attributes.  This property is captured both for RIM attributes and in MIMs.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>Vocab_strength<a name=\"Vocab_strength\"> </a></td><td>Vocabulary strength</td><td>\n                        Captures the strength of encoding for the elements of a coded attribute. This property is captured both for RIM attributes and in MIMs.<br/>\r\n\n                     </td></tr>\r\n <tr><td>1</td><td>zhxID<a name=\"zhxID\"> </a></td><td>History identifier</td><td>\n                        This component tracks the version history of each element of the model.  It contains the unique element identifier assigned to each model element.  The repository assigns values for this element.  Modelers should not change these values or assign new ones, but they may copy them to indicate an element's historic predecessor.<br/>\r\n\n                     </td></tr>\r\n</table>\r\n</div>"
  },
  "identifier": "http://hl7.org/fhir/v3/vs/HL7DefinedRoseProperty",
  "name": "v3 Code System HL7DefinedRoseProperty",
  "publisher": "HL7, Inc",
  "telecom": [
    {
      "system": "url",
      "value": "http://hl7.org"
    }
  ],
  "description": " The property Ids that HL7 has defined for customizing Rational Rose.  Deprecation Comment:\r\nDeprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used.",
  "status": "active",
  "date": "2014-08-07T00:00:00+10:00",
  "define": {
    "system": "http://hl7.org/fhir/v3/HL7DefinedRoseProperty",
    "caseSensitive": true,
    "concept": [
      {
        "code": "ApplicationRoleI",
        "display": "Application Role",
        "definition": "Holds the unique identifier of an Application Role (stereotype of class)."
      },
      {
        "code": "Cardinality",
        "display": "Attribute Cardinality",
        "definition": "Records the constraints on the cardinality of attributes as documented in the RIM and in MIMs."
      },
      {
        "code": "DeleteFromMIM",
        "display": "MIM Delete",
        "definition": "Used in constructing a Message Information Model to indicate which attributes to omit from the MIM."
      },
      {
        "code": "DevelopingCommit",
        "display": "Developing committee",
        "definition": "Holds the id of the HL7 committee developing the model like \"C00.\""
      },
      {
        "code": "DTsymbol",
        "display": "Data type symbol",
        "definition": "Holds the symbol for a defined data type (stereotype of class)."
      },
      {
        "code": "EndState",
        "display": "End state",
        "definition": "The HL7 MDF says that leaf level use cases should be connected to a state transition of the subject class.  The use case diagram provides the link to the subject class.  The modeler must use three properties to identify the state transition -- this property and the two following ones named StartState and StateTransition.  The first two are, as their names imply, the names of the starting state and ending state of the transition, and the third is the name of the transition."
      },
      {
        "code": "HMD",
        "display": "HMD identifier",
        "definition": "The identifier of the HMD from which the message structure for the message transferred by an interaction is drawn."
      },
      {
        "code": "ID",
        "display": "Identifier",
        "definition": "Holds the unique identifier of use cases, interactions and storyboards."
      },
      {
        "code": "InstancedDTsymbo",
        "display": "Data type instantiated",
        "definition": "Holds the data type assigned to the generic type parameter when an instantiation of generic type is recorded."
      },
      {
        "code": "IsPrimitiveDT",
        "display": "Primitive data type",
        "definition": "Indicates that a data type definition is for a primitive data type (stereotype of class)."
      },
      {
        "code": "IsReferenceDT",
        "display": "Reference data type",
        "definition": "Indicates that the type for a data type component (attribute of a data type stereotype of class) is found by reference."
      },
      {
        "code": "IsSubjectClass",
        "display": "Subject class",
        "definition": "Set true for classes that are subject classes."
      },
      {
        "code": "MandatoryInclusi",
        "display": "Mandatory",
        "definition": "Indicates with a value of \"True\" whether the inclusion of an attribute in an HMD and in the messages derived from that HMD is mandatory.  The default is not mandatory, and use of mandatory inclusion in the RIM is deprecated."
      },
      {
        "code": "MayRepeat",
        "display": "Attribute may repeat",
        "definition": "Indicates with values of \"True\" or \"False\" whether an attribute may repeat in an HMD.  The default is non-repeating."
      },
      {
        "code": "MIM_id",
        "display": "MIM Identifier",
        "definition": "Used in a subject area category that holds a MIM.  It provides the unique identifier for the MIM.  The first portion of this identifier should be the ModelID of the RIM from which the MIM is derived."
      },
      {
        "code": "ModelDate",
        "display": "Model date",
        "definition": "A text version of the last modified date formatted like \"19970606\""
      },
      {
        "code": "ModelDescription",
        "display": "Model description",
        "definition": "Contains the textual description of the model."
      },
      {
        "code": "ModelID",
        "display": "Model identifier",
        "definition": "Holds the unique identifier assigned to this model."
      },
      {
        "code": "ModelName",
        "display": "Model name",
        "definition": "Holds the formal name for the model"
      },
      {
        "code": "ModelVersion",
        "display": "Model version",
        "definition": "A text version of the version number like \"V 30-08\""
      },
      {
        "code": "MsgID",
        "display": "Message type identifier",
        "definition": "The identifier of the message structure within the HMD (above) that defines the message transferred by an interaction."
      },
      {
        "code": "Organization",
        "display": "Developing organization",
        "definition": "This is the organization defining the model, \"Health_Level_Seven\""
      },
      {
        "code": "RcvResp",
        "display": "Receiver responsibility",
        "definition": "This property holds the identifier of the follow-on interaction, when the receiving application role for an interaction has the responsibility to initiate a follow-on interaction."
      },
      {
        "code": "RespComm_id",
        "display": "Responsible committee ID",
        "definition": "Captures the identifier of the responsible committee for all subject areas and categories."
      },
      {
        "code": "StartState",
        "display": "Start state",
        "definition": "(See description of EndState above)."
      },
      {
        "code": "StateAttribute",
        "display": "State attribute",
        "definition": "For classes that are subject classes, this component provides the name of the state attribute for the class.  Only one state attribute component may appear for a given class."
      },
      {
        "code": "StateTransition",
        "display": "State transition",
        "definition": "(See description of EndState above.)"
      },
      {
        "code": "V23_Datatype",
        "display": "Version 2 data type",
        "definition": "This component can document the Version 2.3 datatype for an attribute that is related to or derived from data fields in HL7 Version 2.3."
      },
      {
        "code": "V23_Fields",
        "display": "Version 2 Field reference",
        "definition": "This component provides a reference to the source Version 2.x field for an attribute that is related to or derived from data fields in HL7 Version 2.3 standard.  Concatenate multiple values with commas, if multiple references to Version 2.x exist for an attribute."
      },
      {
        "code": "Vocab_domain",
        "display": "Vocabulary domain",
        "definition": "Captures the identifier (name) of the vocabulary domain that constrains the values of coded attributes.  This property is captured both for RIM attributes and in MIMs."
      },
      {
        "code": "Vocab_strength",
        "display": "Vocabulary strength",
        "definition": "Captures the strength of encoding for the elements of a coded attribute. This property is captured both for RIM attributes and in MIMs."
      },
      {
        "code": "zhxID",
        "display": "History identifier",
        "definition": "This component tracks the version history of each element of the model.  It contains the unique element identifier assigned to each model element.  The repository assigns values for this element.  Modelers should not change these values or assign new ones, but they may copy them to indicate an element's historic predecessor."
      }
    ]
  }
}