Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Valueset-example.xml

Vocabulary Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

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

Jump past Narrative

ValueSet Example using enumeration of codes (extensional) (id = "example-extensional")

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

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="example-extensional"/> 
  <meta> 
    <!--     shareable value sets are fully described, and can be put in the HL7 registry     -->
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Value set &quot;LOINC Codes for Cholesterol&quot;: This is an example value set that includes
         
        all the  codes for serum cholesterol from LOINC v2.36.</p> 
      <p> Developed by: FHIR project team (example)</p> 
      <p> Published for testing on 13-June 2012</p> 
      <p> This value set includes the following LOINC codes:</p> 
      <ul> 
        <li> 14647-2: Cholesterol [Moles/Volume]</li> 
        <li> 2093-3: Cholesterol [Mass/Volume]</li> 
        <li> 35200-5: Cholesterol [Mass Or Moles/Volume] </li> 
        <li> 9342-7: Cholesterol [Percentile]</li> 
      </ul> 
      <p> This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC
         Committee, and available at no cost under the license at http://loinc.org/terms-of-use.</p> 
    </div> 
  </text> 
  <!--     
    for this example, we use a real URI, since this example does have a canonical address
    at which it's posted. Alternatively, We could have used an OID, or a UUID.
 
    Mote that this isn't the identifier for the LOINC codes themeselves - they belong
   to LOINC, and 
    it has its own identifier. This is the identifier for this set of codes, and that doesn't
   
    change the codes.
      -->
  <url value="http://hl7.org/fhir/ValueSet/example-extensional"/> 
  <!--     an imaginary identifier. This is a non FHIR identifier - might be used in a 
    v2 context (though you always need to translate namespaces for v2)     -->
  <identifier> 
    <system value="http://acme.com/identifiers/valuesets"/> 
    <value value="loinc-cholesterol-int"/> 
  </identifier> 
  <!--     for version, we are going to simply use the day of publication. This is also 
    arbitrary - whatever is here is what people use to refer to the version. 
    Could also be a UUID too     -->
  <version value="20150622"/> 
  <!--     set of loinc codes for cholesterol for LONC 2.36     -->
  <name value="LOINC Codes for Cholesterol in Serum/Plasma"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <date value="2015-06-22"/> 
  <publisher value="HL7 International"/> 
  <contact> 
    <name value="FHIR project team"/> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="This is an example value set that includes all the LOINC codes for serum/plasma cholesterol
   from v2.36."/> 
  <useContext> 
    <code> 
      <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/> 
      <code value="age"/> 
    </code> 
    <valueQuantity> 
      <value value="18"/> 
      <comparator value="&gt;"/> 
      <unit value="yrs"/> 
      <system value="http://unitsofmeasure.org"/> 
      <code value="a"/>       
    </valueQuantity> 
  </useContext> 
  <jurisdiction> 
    <coding> 
      <system value="urn:iso:std:iso:3166"/> 
      <code value="US"/> 
    </coding>   
  </jurisdiction> 
  <purpose value="This value set was published by ACME Inc in order to make clear which codes are used for
   Cholesterol by AcmeClinicals (Adult Ambulatory care support in USA)"/> 
  <copyright value="This content from LOINC ® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC
   Committee, and available at no cost under the license at http://loinc.org/terms-of-use."/> 
  <compose> 
    <!--      
    if we didn't specify the version of LOINC on the include, then
    we could specify it implicitly by specifying the locked date for the value set
    
    So we show this example here, but it's not actually necessary since we also 
    have LOINC version. Note: if you do what this example does, and specify both,
    you better get it right, and specify the current version of LOINC at the time
      -->
    <lockedDate value="2012-06-13"/> 
    <!--  
    Including inactive codes means that retired and deprecated codes may still be used
     in the
    value set
      -->
    <inactive value="true"/> 
    <!--     you could have multiple includes, if you wanted to include codes from more than
     one code system, or include codes with different modes. we don't, in this case  
       -->
    <include> 
      <system value="http://loinc.org"/> 
      <version value="2.36"/> 
      <!--     for LOINC, we simply include the listed codes - no subsumption in LOINC     -->
      <!--     these were selected by hand     -->
      <concept> 
        <code value="14647-2"/> 
        <!--     
          In this value set, we provide our own displays. 
          
          You have to be very careful doing this; it's all too 
          easy to specify a different or lesser meaning, and then
          people use codes wrongly ()with obvious consequences for clinical safety)
        
          You're allowed to do this in a value set for 2 reasons:
            - people do it anyway
            - it does make sense to remove common text that's fixed in the context
            
          In this case, that's what we're doing here - removing
          'serum/plasma' from the names, since that's specified in the
          value set name     -->
        <display value="Cholesterol [Moles/Volume]"/> 
      </concept> 
      <concept> 
        <code value="2093-3"/> 
        <display value="Cholesterol [Mass/Volume]"/> 
      </concept> 
      <concept> 
        <code value="35200-5"/> 
        <display value="Cholesterol [Mass Or Moles/Volume]"/> 
      </concept> 
      <!--     this is a different kind of code; whether it should be 
        in a value set like this is a matter of clinical judgement.
        it's here in this example value set to raise the question
        for implementers     -->
      <concept> 
        <code value="9342-7"/> 
        <display value="Cholesterol [Percentile]"/> 
      </concept> 
    </include> 
  </compose> 
</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.