This page is part of the US Core (v0.0.0: STU1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

US Core Birth Sex Extension

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="us-core-birthsex"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex">http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex</a></p><p><b>name</b>: US Core Birth Sex Extension</p><p><b>title</b>: US Core Birth Sex Extension</p><p><b>status</b>: DRAFT</p><p><b>date</b>: 01/08/2016</p><p><b>publisher</b>: Health Level Seven International (FHIR-Infrastructure)</p><p><b>contact</b>: </p><p><b>description</b>: A code classifying the person's sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc).</p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex">http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex</a></p><p><b>name</b>: US Core Birth Sex Extension</p><p><b>title</b>: US Core Birth Sex Extension</p><p><b>status</b>: DRAFT</p><p><b>publisher</b>: Health Level Seven International (FHIR-Infrastructure)</p><p><b>contact</b>: </p><p><b>date</b>: 01/08/2016</p><p><b>description</b>: A code classifying the person's sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc).</p><p><b>fhirVersion</b>: 1.8.0</p><h3>Mappings</h3><table class="grid"><tr><td>-</td><td><b>Identity</b></td><td><b>Uri</b></td><td><b>Name</b></td></tr><tr><td>*</td><td>rim</td><td><a href="http://hl7.org/v3">http://hl7.org/v3</a></td><td>RIM Mapping</td></tr></table><p><b>kind</b>: COMPLEXTYPE</p><p><b>abstract</b>: false</p><p><b>contextType</b>: RESOURCE</p><p><b>context</b>: Patient</p><p><b>type</b>: Extension</p><p><b>baseDefinition</b>: <a href="http://hl7.org/fhir/StructureDefinition/Extension">http://hl7.org/fhir/StructureDefinition/Extension</a></p><p><b>derivation</b>: CONSTRAINT</p><h3>Snapshots</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table><h3>Differentials</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table></div>
  </text>
  <url value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"/>
  <name value="US Core Birth Sex Extension"/>
  <title value="US Core Birth Sex Extension"/>
  <status value="draft"/>
  <publisher value="Health Level Seven International (FHIR-Infrastructure)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.healthit.gov"/>
    </telecom>
  </contact>
  <date value="2016-08-01"/>
  <description
               value="A code classifying the person&#39;s sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc)."/>
  <fhirVersion value="1.8.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:birthsex">
      <path value="Extension"/>
      <sliceName value="birthsex"/>
      <short value="Extension"/>
      <definition
                  value="A code classifying the person&#39;s sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc)."/>
      <comments
                value="The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex."/>
      <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="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(.), &#39;value&#39;)])"/>
        <source value="Extension"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-8"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map
             value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"/>
      </mapping>
      <mapping>
        <identity value="iso11179"/>
        <map value=".patient.administrativeGenderCode"/>
      </mapping>
    </element>
    <element id="Extension:birthsex.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:birthsex.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:birthsex.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://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Extension:birthsex.valueCode">
      <path value="Extension.valueCode"/>
      <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="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <description value="Code for sex assigned at birth"/>
        <valueSetReference>
          <reference
                     value="http://hl7.org/fhir/us/core/ValueSet/us-core-birthsex"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Extension:birthsex">
      <path value="Extension"/>
      <sliceName value="birthsex"/>
      <definition
                  value="A code classifying the person&#39;s sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc)."/>
      <comments
                value="The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex."/>
      <min value="0"/>
      <max value="1"/>
      <isModifier value="false"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-8"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map
             value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"/>
      </mapping>
      <mapping>
        <identity value="iso11179"/>
        <map value=".patient.administrativeGenderCode"/>
      </mapping>
    </element>
    <element id="Extension:birthsex.url">
      <path value="Extension.url"/>
      <fixedUri
                value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"/>
    </element>
    <element id="Extension:birthsex.value[x]">
      <path value="Extension.value[x]"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <description value="Code for sex assigned at birth"/>
        <valueSetReference>
          <reference
                     value="http://hl7.org/fhir/us/core/ValueSet/us-core-birthsex"/>
        </valueSetReference>
      </binding>
    </element>
  </differential>
</StructureDefinition>