Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example ValueSet/inactive (XML)

Terminology Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : No defined compartments

Raw XML ( canonical form + also see XML Format Specification )

Jump past Narrative

ValueSet including inactive concepts (id = "inactive") 

<?xml version="1.0" encoding="UTF-8"?>

  
  
    
    
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
            1
          
            
            
          
          
          
          
            
              
                
                  

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="inactive"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This value set contains 5 concepts</p> 
      <table class="codes">
        <tr> 
          <td> 
            <b> Level</b> 
          </td> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> System</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Inactive</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td> 
            <a name="http---terminology.hl7.org-CodeSystem-v3-ActMood-CRT"> </a> 1
          </td> 
          <td style="white-space:nowrap">  
            <a href="http://terminology.hl7.org/5.4.0/CodeSystem-v3-ActMood.html#v3-ActMood-CRT">CRT</a> 
          </td> 
          <td> http://terminology.hl7.org/CodeSystem/v3-ActMood</td> 
          <td> criterion</td> 
          <td> inactive</td> 
          <td> 
            <div> 
              <p> 
                <em> 
                  <strong> Deprecation Comment:</strong> 
                </em>  This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd
                 to &quot;true&quot; and use the desired mood for your criterion.
              
              
                 A condition that must be true for the source act to be considered.
              
            
          
        
        
          
            1
          
            
            
          
          
          
          
            
              

                 to &quot;true&quot; and use the desired mood for your criterion.
              </p> 


              <p> 
                <strong> Definition:</strong>  A condition that must be true for the source act to be considered.
              </p> 


            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 
            <a name="http---terminology.hl7.org-CodeSystem-v3-ActMood-EXPEC"> </a> 1
          </td> 
          <td style="white-space:nowrap">  
            <a href="http://terminology.hl7.org/5.4.0/CodeSystem-v3-ActMood.html#v3-ActMood-EXPEC">EXPEC</a> 
          </td> 
          <td> http://terminology.hl7.org/CodeSystem/v3-ActMood</td> 
          <td> expectation</td> 
          <td/>  
          <td> 
            <div> 
              <p> 
                <strong> Definition:</strong>  An act that is considered to have some noteworthy likelihood of occurring in the
                 future (has_match = event).
              

                 future (has_match = event).
              </p> 



              <p> **Examples:**Prognosis of a condition, Expected date of discharge from hospital,
                 patient will likely need an emergency decompression of the intracranial pressure
                 by morning.

                 by morning.</p> 


              <p> **UsageNotes:**INT (intent) reflects a plan for the future, which is a declaration
                 to do something. This contrasts with expectation, which is a prediction that something
                 will happen in the future. GOL (goal) reflects a hope rather than a prediction.
                 RSK (risk) reflects a potential negative event that may or may not be expected
                 to happen.
            
          
        
        
          
            2
          
              
            
          
          
          
          
            
              
                 An expectation that is considered to be desirable to occur in the future
              

                 to happen.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 
            <a name="http---terminology.hl7.org-CodeSystem-v3-ActMood-GOL"> </a> 2
          </td> 
          <td style="white-space:nowrap">    
            <a href="http://terminology.hl7.org/5.4.0/CodeSystem-v3-ActMood.html#v3-ActMood-GOL">GOL</a> 
          </td> 
          <td> http://terminology.hl7.org/CodeSystem/v3-ActMood</td> 
          <td> goal</td> 
          <td/>  
          <td> 
            <div> 
              <p> 
                <strong> Definition:</strong>  An expectation that is considered to be desirable to occur in the future
              </p> 



              <p> **Examples:**Target weight below 80Kg, Stop smoking, Regain ability to walk, goal
                 is to administer thrombolytics to candidate patients presenting with acute myocardial
                 infarction.
              

                 infarction.</p> 

              <p> 
                <strong> UsageNotes:</strong>  INT (intent) reflects a plan for the future, which is a declaration to do something.
                 This contrasts with goal which doesn't represent an intention to act, merely a
                 hope for an eventual result. A goal is distinct from the intended actions to reach
                 that goal. &quot;I will reduce the dose of drug x to 20mg&quot; is an intent. &quot;I
                 hope to be able to get the patient to the point where I can reduce the dose of
                 drug x to 20mg&quot; is a goal. EXPEC (expectation) reflects a prediction rather
                 than a hope. RSK (risk) reflects a potential negative event rather than a hope.
              
            
          
        
        
          
            2
          
              
            
          
          
          
          
            
              
              

                 than a hope. RSK (risk) reflects a potential negative event rather than a hope.
              </p> 


            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 
            <a name="http---terminology.hl7.org-CodeSystem-v3-ActMood-RSK"> </a> 2
          </td> 
          <td style="white-space:nowrap">    
            <a href="http://terminology.hl7.org/5.4.0/CodeSystem-v3-ActMood.html#v3-ActMood-RSK">RSK</a> 
          </td> 
          <td> http://terminology.hl7.org/CodeSystem/v3-ActMood</td> 
          <td> risk</td> 
          <td/>  
          <td> 
            <div> 
              <p> **Definition:**An act that may occur in the future and which is regarded as undesirable</p> 


              <p> **Examples:**Increased risk of DVT, at risk for sub-acute bacterial endocarditis.</p> 



              <p> **UsageNotes:**Note: An observation in RSK mood expresses the undesirable act,
                 and not the underlying risk factor. A risk factor that is present (e.g. obesity,
                 smoking, etc) should be expressed in event mood. INT (intent) reflects a plan for
                 the future, which is a declaration to do something. This contrasts with RSK (risk),
                 which is the potential that something negative will occur that may or may not ever
                 happen. GOL (goal) reflects a hope to achieve something. EXPEC (expectation) is
                 the prediction of a positive or negative event. This contrasts with RSK (risk),
                 which is the potential that something negative will occur that may or may not ever
                 happen, and may not be expected to happen.
            
          
        
        
          
            1
          
            
            
          
          
          
          
            
              

                 happen, and may not be expected to happen.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 
            <a name="http---terminology.hl7.org-CodeSystem-v3-ActMood-OPT"> </a> 1
          </td> 
          <td style="white-space:nowrap">  
            <a href="http://terminology.hl7.org/5.4.0/CodeSystem-v3-ActMood.html#v3-ActMood-OPT">OPT</a> 
          </td> 
          <td> http://terminology.hl7.org/CodeSystem/v3-ActMood</td> 
          <td> option</td> 
          <td/>  
          <td> 
            <div> 
              <p> 
                <strong> Definition:</strong>  One of a set of acts that specify an option for the property values that the parent
                 act may have. Typically used in definitions or orders to describe alternatives.
                 An option can only be used as a group, that is, all assigned values must be used
                 together. The actual mood of the act is the same as the parent act, and they must
                 be linked by an actrelationship with type = OPTN.
              
            
          
        
      
    
  
  
  
    
    
  
  
  
  
  
  
  
  
    
    
      
      
        
        
        
      
    
  
  
    
    
    
      
      
      
      
    
    
      
      
      
      
        
        
        
      
      
        
        
        
      
    
    
      
      
      
    
  

                 be linked by an actrelationship with type = OPTN.
              </p> 


            </div> 
          </td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="vocab"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/inactive"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.3146"/> 
  </identifier> 
  <version value="6.0.0-ballot1"/> 
  <name value="ExampleInactive"/> 
  <title value="Example with inactive codes"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <publisher value="HL7 International / Terminology Infrastructure"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/Vocab"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/Vocab/index.cfm"/> 
    </telecom> 
  </contact> 
  <description value="HL7 v3 ActMood Predicate codes, including inactive codes"/> 
  <compose> 
    <inactive value="true"/> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActMood"/> 
      <filter> 
        <property value="concept"/> 
        <op value="descendent-of"/> 
        <value value="_ActMoodPredicate"/> 
      </filter> 
    </include> 
  </compose> 
  <expansion> 
    <identifier value="urn:uuid:46c00b3f-003a-4f31-9d4b-ea2de58b2a99"/> 
    <timestamp value="2017-02-26T10:00:00Z"/> 
    <contains> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActMood"/> 
      <inactive value="true"/> 
      <code value="CRT"/> 
      <display value="criterion"/> 
    </contains> 
    <contains> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActMood"/> 
      <code value="EXPEC"/> 
      <display value="expectation"/> 
      <contains> 
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActMood"/> 
        <code value="GOL"/> 
        <display value="goal"/> 
      </contains> 
      <contains> 
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActMood"/> 
        <code value="RSK"/> 
        <display value="risk"/> 
      </contains> 
    </contains> 
    <contains> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActMood"/> 
      <code value="OPT"/> 
      <display value="option"/> 
    </contains> 
  </expansion> 


</

ValueSet

>

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.