FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3

V3-RoleStatus.cs.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

Codes representing the defined possible states of an Role, as defined by the Role class state machine.

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-RoleStatus"/> 
  <meta> 
    <lastUpdated value="2016-11-11T00:00:00.000+11:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Release Date: 2016-11-11</p> 

      <table class="grid">
 
        <tr> 
          <td> 
            <b> Level</b> 
          </td> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> normal
            <a name="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.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   active
            <a name="active"> </a> 
          </td> 
          <td> active</td> 
          <td> 
                        The state representing the fact that the Entity is currently active
               in the Role.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   cancelled
            <a name="cancelled"> </a> 
          </td> 
          <td> cancelled</td> 
          <td> 
                        The terminal state resulting from cancellation of the role prior
               to activation.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   pending
            <a name="pending"> </a> 
          </td> 
          <td> pending</td> 
          <td> 
                        The state representing that fact that the role has not yet become
               active.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   suspended
            <a name="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.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   terminated
            <a name="terminated"> </a> 
          </td> 
          <td> terminated</td> 
          <td> 
                        The state representing the successful termination of the Role.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> nullified
            <a name="nullified"> </a> 
          </td> 
          <td> nullified</td> 
          <td> 
                        The state representing the termination of a Role instance that
               was created in error.
            <br/>  

                     
          </td> 
        </tr> 

      </table> 

    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status">
    <valueString value="External"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <url value="http://hl7.org/fhir/v3/RoleStatus"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.5.1068"/> 
  </identifier> 
  <version value="2016-11-11"/> 
  <name value="v3 Code System RoleStatus"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2016-11-11T00:00:00+11:00"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value=" Codes representing the defined possible states of an Role, as defined by the Role class
     state machine."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/v3-RoleStatus"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <concept> 
    <code value="normal"/> 
    <display value="normal"/> 
    <definition value="The 'typical' state. Excludes &quot;nullified&quot; which represents the termination state
       of a Role instance that was created in error."/> 
    <concept> 
      <code value="active"/> 
      <display value="active"/> 
      <definition value="The state representing the fact that the Entity is currently active in the Role."/> 
    </concept> 
    <concept> 
      <code value="cancelled"/> 
      <display value="cancelled"/> 
      <definition value="The terminal state resulting from cancellation of the role prior to activation."/> 
    </concept> 
    <concept> 
      <code value="pending"/> 
      <display value="pending"/> 
      <definition value="The state representing that fact that the role has not yet become active."/> 
    </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."/> 
    </concept> 
    <concept> 
      <code value="terminated"/> 
      <display value="terminated"/> 
      <definition value="The state representing the successful termination of the Role."/> 
    </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."/> 
  </concept> 
</CodeSystem> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.