This page is part of the HSPC FHIR Implementation Guide (v0.1.0: Daft For Comment Draft) based on FHIR v1.9.0. This is the current published version. For a full list of available versions, see the Directory of published versions

href="assets/ico/favicon.png"/>

Citezenship Period

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="extensions-citezenshipPeriod"/>
  <url
       value="http://fhir.org/guides/hspc/StructureDefinition/extensions-citezenshipPeriod"/>
  <name value="Citezenship Period"/>
  <display value="Citezenship Period"/>
  <status value="draft"/>
  <publisher value="HSPC"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://healthcaresoa.org"/>
    </telecom>
  </contact>
  <date value="2015-07-29"/>
  <description
               value="The start time and end time an individual claims to be or have been a member of a country."/>
  <fhirVersion value="1.5.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="Patient"/>
  <type value="Extension"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Extension:citezenshipperiod">
      <path value="Extension"/>
      <name value="citezenshipPeriod"/>
      <short value="Extension"/>
      <definition
                  value="The start time and end time an individual claims to be or have been a member of a country."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <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')])"/>
      </constraint>
      <isModifier value="false"/>
    </element>
    <element id="Extension:citezenshipperiod.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="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Extension:citezenshipperiod.extension">
      <path value="Extension.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition
                  value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
      <comments
                value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Extension:citezenshipperiod.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."/>
      <comments
                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://fhir.org/guides/hspc/StructureDefinition/extensions-citezenshipPeriod"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Extension:citezenshipperiod.valuePeriod">
      <path value="Extension.valuePeriod"/>
      <short value="Time range defined by start and end date/time"/>
      <definition
                  value="A time period defined by a start and end date and optionally time."/>
      <comments
                value="This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Extension.value[x]"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Period"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Period"/>
      </type>
      <constraint>
        <key value="per-1"/>
        <severity value="error"/>
        <human value="If present, start SHALL have a lower value than end"/>
        <expression value="start.empty() or end.empty() or (start <= end)"/>
        <xpath
               value="not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="DR"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map
             value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Extension:citezenshipperiod">
      <path value="Extension"/>
      <name value="citezenshipPeriod"/>
      <definition
                  value="The start time and end time an individual claims to be or have been a member of a country."/>
      <min value="0"/>
      <max value="1"/>
      <isModifier value="false"/>
    </element>
    <element id="Extension:citezenshipperiod.url">
      <path value="Extension.url"/>
      <fixedUri
                value="http://fhir.org/guides/hspc/StructureDefinition/extensions-citezenshipPeriod"/>
    </element>
    <element id="Extension:citezenshipperiod.value[x]">
      <path value="Extension.value[x]"/>
      <type>
        <code value="Period"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Period"/>
      </type>
    </element>
  </differential>
</StructureDefinition>