R6 Ballot (2nd Draft)

Publish-box (todo)

Example ValueSet/marital-status (XML)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Value SetMarital Status Codes

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

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="marital-status"/> 
  <meta> 
    <lastUpdated value="2024-08-12T16:52:12.437+08:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: ValueSet marital-status</b> 
      </p> 
      <a name="marital-status"> </a> 
      <a name="hcmarital-status"> </a> 
      <a name="marital-status-en-AU"> </a> 
      <p> This value set includes codes based on the following rules:</p> 
      <ul> 
        <li> Include all codes defined in 
          <a href="http://terminology.hl7.org/6.0.2/CodeSystem-v3-MaritalStatus.html">
            <code> http://terminology.hl7.org/CodeSystem/v3-MaritalStatus</code> 
          </a> 
        </li> 
        <li> Include these codes as defined in 
          <a href="http://terminology.hl7.org/6.0.2/CodeSystem-v3-NullFlavor.html">
            <code> http://terminology.hl7.org/CodeSystem/v3-NullFlavor</code> 
          </a> 
          <table class="none">
            <tr> 
              <td style="white-space:nowrap">
                <b> Code</b> 
              </td> 
              <td> 
                <b> Display</b> 
              </td> 
              <td> 
                <b> Definition</b> 
              </td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/6.0.2/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-UNK">UNK</a> 
              </td> 
              <td style="color: #cccccc">unknown</td> 
              <td> **Description:**A proper value is applicable, but not known.
                <br/>  
                <br/>  **Usage Notes**: This means the actual value is not known. If the only thing that
                 is unknown is how to properly express the value in the necessary constraints (value
                 set, datatype, etc.), then the OTH or UNC flavor should be used. No properties
                 should be included for a datatype with this property unless:
                <br/>  
                <br/>  1.  Those properties themselves directly translate to a semantic of &quot;unknown&quot;.
                 (E.g. a local code sent as a translation that conveys 'unknown')
                <br/>  2.  Those properties further qualify the nature of what is unknown. (E.g. specifying
                 a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to convey that
                 it is the home phone number that is unknown.)
              </td> 
            </tr> 
          </table> 
        </li> 
      </ul> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pa"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/marital-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.29"/> 
  </identifier> 
  <version value="6.0.0-ballot2"/> 
  <name value="MaritalStatusCodes"/> 
  <title value="Marital Status Codes"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2024-08-12T16:52:12+08:00"/> 
  <publisher value="FHIR Project team"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="This value set defines the set of codes that can be used to indicate the marital
   status of a person."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-MaritalStatus"/> 
    </include> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor"/> 
      <concept> 
        <code value="UNK"/> 
      </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.