HL7 Terminology
1.0.0 - Publication

This page is part of the HL7 Terminology (v1.0.0: Release) based on FHIR R4. The current version which supercedes this version is 5.2.0. For a full list of available versions, see the Directory of published versions

RoleStatus - XML Representation

(back to description)

Raw xml

Source view 


<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-RoleStatus"/>
  <language value="en"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><h2>RoleStatus</h2><div><p>Codes representing the defined possible states of an Role, as defined by the Role class state machine.</p>
</div><p><b>Properties</b></p><table class="grid"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Description</b></td><td><b>Type</b></td></tr><tr><td>Specializes</td><td/><td>The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric.</td><td>Coding</td></tr><tr><td>Generalizes</td><td/><td>Inverse of Specializes.  Only included as a derived relationship.</td><td>Coding</td></tr><tr><td>internalId</td><td>http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id</td><td>The internal identifier for the concept in the HL7 Access database repository.</td><td>code</td></tr><tr><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>Designation of a concept's state. Normally is not populated unless the state is retired.</td><td>code</td></tr></table><p>This code system http://terminology.hl7.org/CodeSystem/v3-RoleStatus defines the following codes:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>internalId</b></td><td><b>status</b></td></tr><tr><td>1</td><td style="white-space:nowrap">normal<a name="v3-RoleStatus-normal"> </a></td><td>normal</td><td>The 'typical' state. Excludes &quot;nullified&quot; which represents the termination state of a Role instance that was created in error.</td><td>16000</td><td>active</td></tr><tr><td>2</td><td style="white-space:nowrap">  active<a name="v3-RoleStatus-active"> </a></td><td>active</td><td>The state representing the fact that the Entity is currently active in the Role.</td><td>16001</td><td>active</td></tr><tr><td>2</td><td style="white-space:nowrap">  cancelled<a name="v3-RoleStatus-cancelled"> </a></td><td>cancelled</td><td>The terminal state resulting from cancellation of the role prior to activation.</td><td>21306</td><td>active</td></tr><tr><td>2</td><td style="white-space:nowrap">  pending<a name="v3-RoleStatus-pending"> </a></td><td>pending</td><td>The state representing that fact that the role has not yet become active.</td><td>21305</td><td>active</td></tr><tr><td>2</td><td style="white-space:nowrap">  suspended<a name="v3-RoleStatus-suspended"> </a></td><td>suspended</td><td>The state that represents a suspension of the Entity playing the Role. This state is arrived at from the &quot;active&quot; state.</td><td>16002</td><td>active</td></tr><tr><td>2</td><td style="white-space:nowrap">  terminated<a name="v3-RoleStatus-terminated"> </a></td><td>terminated</td><td>The state representing the successful termination of the Role.</td><td>16003</td><td>active</td></tr><tr><td>1</td><td style="white-space:nowrap">nullified<a name="v3-RoleStatus-nullified"> </a></td><td>nullified</td><td>The state representing the termination of a Role instance that was created in error.</td><td>16004</td><td>active</td></tr></table></div>
  </text>
  <url value="http://terminology.hl7.org/CodeSystem/v3-RoleStatus"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.5.1068"/>
  </identifier>
  <version value="2.0.0"/>
  <name value="RoleStatus"/>
  <title value="RoleStatus"/>
  <status value="active"/>
  <date value="2019-03-20T00:00:00-04:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="Health Level Seven"/>
  </contact>
  <description
               value="Codes representing the defined possible states of an Role, as defined by the Role class state machine."/>
  <hierarchyMeaning value="is-a"/>
  <content value="complete"/>
  <property>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry">
      <valueCode value="antisymmetric"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity">
      <valueCode value="transitive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity">
      <valueCode value="irreflexive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable">
      <valueBoolean value="true"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind">
      <valueCode value="Specializes"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName">
      <valueString value="Generalizes"/>
    </extension>
    <code value="Specializes"/>
    <description
                 value="The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric."/>
    <type value="Coding"/>
  </property>
  <property>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry">
      <valueCode value="antisymmetric"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity">
      <valueCode value="transitive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity">
      <valueCode value="irreflexive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable">
      <valueBoolean value="true"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind">
      <valueCode value="Generalizes"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName">
      <valueString value="Specializes"/>
    </extension>
    <code value="Generalizes"/>
    <description
                 value="Inverse of Specializes.  Only included as a derived relationship."/>
    <type value="Coding"/>
  </property>
  <property>
    <code value="internalId"/>
    <uri
         value="http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id"/>
    <description
                 value="The internal identifier for the concept in the HL7 Access database repository."/>
    <type value="code"/>
  </property>
  <property>
    <code value="status"/>
    <uri value="http://hl7.org/fhir/concept-properties#status"/>
    <description
                 value="Designation of a concept&#39;s state. Normally is not populated unless the state is retired."/>
    <type value="code"/>
  </property>
  <concept>
    <code value="normal"/>
    <display value="normal"/>
    <definition
                value="The &#39;typical&#39; state. Excludes &quot;nullified&quot; which represents the termination state of a Role instance that was created in error."/>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="16000"/>
    </property>
    <concept>
      <code value="active"/>
      <display value="active"/>
      <definition
                  value="The state representing the fact that the Entity is currently active in the Role."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="16001"/>
      </property>
    </concept>
    <concept>
      <code value="cancelled"/>
      <display value="cancelled"/>
      <definition
                  value="The terminal state resulting from cancellation of the role prior to activation."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="21306"/>
      </property>
    </concept>
    <concept>
      <code value="pending"/>
      <display value="pending"/>
      <definition
                  value="The state representing that fact that the role has not yet become active."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="21305"/>
      </property>
    </concept>
    <concept>
      <code value="suspended"/>
      <display value="suspended"/>
      <definition
                  value="The state that represents a suspension of the Entity playing the Role. This state is arrived at from the &quot;active&quot; state."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="16002"/>
      </property>
    </concept>
    <concept>
      <code value="terminated"/>
      <display value="terminated"/>
      <definition
                  value="The state representing the successful termination of the Role."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="16003"/>
      </property>
    </concept>
  </concept>
  <concept>
    <code value="nullified"/>
    <display value="nullified"/>
    <definition
                value="The state representing the termination of a Role instance that was created in error."/>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="16004"/>
    </property>
  </concept>
</CodeSystem>