R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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: R4B R4 R3 R2

Extension-valueset-expirationdate.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

expirationDate

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="valueset-expirationDate"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="vocab"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/valueset-expirationDate"/> 
  <name value="expirationDate"/> 
  <status value="draft"/> 
  <date value="2017-12-20T15:52:34+11:00"/> 
  <publisher value="HL7"/> 
  <description value="The date when the value set version is no longer expected to be used to create new content.
   This is the first date-time when the value set version becomes Inactive, so this value
   SHALL present on all Inactive value set versions. The start Date_time is expected to be
   as of 0001 UTC of the Expiration Date."/> 
  <fhirVersion value="3.2.0"/> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <contextType value="resource"/> 
  <context value="ValueSet"/> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="When the value set version should no longer be used"/> 
      <definition value="The date when the value set version is no longer expected to be used to create new content.
       This is the first date-time when the value set version becomes Inactive, so this value
       SHALL present on all Inactive value set versions. The start Date_time is expected to be
       as of 0001 UTC of the Expiration Date."/> 
      <comment value="Upon reaching the Expiration Date, the value set Activity Status should be consdiered
       as inactive. An Inactive value set version may no longer be used to create new content,
       but it may be used to evaluate content created prior to the Expiration Date."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <condition value="ele-1"/> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() | (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
    </element> 
    <element id="Extension.id">
      <path value="Extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="xml:id (or equivalent in JSON)"/> 
      <definition value="unique id for the element within a resource (for internal references). This may be any
       string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </type> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="The definition may point directly to a computable or human-readable definition of the
       extensibility codes, or it may be a logical URI as declared in some other specification.
       The definition SHALL be a URI for the Structure Definition defining the extension."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-expirationDate"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.valueDate">
      <path value="Extension.valueDate"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see
       Extensibility in the spec for list)."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="date"/> 
      </type> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="When the value set version should no longer be used"/> 
      <definition value="The date when the value set version is no longer expected to be used to create new content.
       This is the first date-time when the value set version becomes Inactive, so this value
       SHALL present on all Inactive value set versions. The start Date_time is expected to be
       as of 0001 UTC of the Expiration Date."/> 
      <comment value="Upon reaching the Expiration Date, the value set Activity Status should be consdiered
       as inactive. An Inactive value set version may no longer be used to create new content,
       but it may be used to evaluate content created prior to the Expiration Date."/> 
      <min value="0"/> 
      <max value="1"/> 
      <isModifier value="false"/> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-expirationDate"/> 
    </element> 
    <element id="Extension.valueDate">
      <path value="Extension.valueDate"/> 
      <type> 
        <code value="date"/> 
      </type> 
    </element> 
  </differential> 
</StructureDefinition> 

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.