STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension-us-core-birthsex.xml

Raw XML (canonical form)

Sex of patient assigned at birth

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="us-core-birthsex"/>
  <url value="http://hl7.org/fhir/StructureDefinition/us-core-birthsex"/>
  <name value="Sex of patient assigned at birth"/>
  <display value="Sex of patient assigned at birth"/>
  <status value="draft"/>
  <publisher value="Health Level Seven International (US Realm Steering Committee)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://www.hl7.org/Special/Committees/usrealm"/>
    </telecom>
  </contact>
  <date value="2013-12-03"/>
  <description value="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)."/>
  <fhirVersion value="1.6.0"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2 Mapping"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <mapping>
    <identity value="cda"/>
    <uri value="http://hl7.org/v3/cda"/>
    <name value="CDA (R2)"/>
  </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:sexofpatientassignedatbirth">
      <path value="Extension"/>
      <short value="Extension"/>
      <definition value="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)."/>
      <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"/>
      </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')])"/>
      </constraint>
      <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="cda"/>
        <map value=".patient.administrativeGenderCode"/>
      </mapping>
    </element>
    <element id="Extension:sexofpatientassignedatbirth.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:sexofpatientassignedatbirth.extension:extension">
      <path value="Extension.extension"/>
      <name value="extension"/>
      <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:sexofpatientassignedatbirth.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/StructureDefinition/us-core-birthsex"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Extension:sexofpatientassignedatbirth.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="1"/>
      <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/ValueSet/usrealm-birthsex"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Extension:sexofpatientassignedatbirth">
      <path value="Extension"/>
      <definition value="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)."/>
      <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"/>
      <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="cda"/>
        <map value=".patient.administrativeGenderCode"/>
      </mapping>
    </element>
    <element id="Extension:sexofpatientassignedatbirth.extension:extension">
      <path value="Extension.extension"/>
      <name value="extension"/>
      <max value="0"/>
    </element>
    <element id="Extension:sexofpatientassignedatbirth.url">
      <path value="Extension.url"/>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/us-core-birthsex"/>
    </element>
    <element id="Extension:sexofpatientassignedatbirth.value[x]">
      <path value="Extension.value[x]"/>
      <min value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <description value="Code for sex assigned at birth"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/usrealm-birthsex"/>
        </valueSetReference>
      </binding>
    </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.