description: The recorded sex and gender is to be used to differentiate existing sex or gender data. This element is used for existing 'sex' or 'gender' elements in a document or record when the intent and meaning is unclear. For example, the individual's birth certificate information, passport information, and national identity document information may all be present. This is necessary because an individual's documents may be updated at different rates or for different reasons. Sex assigned at birth (SAAB), while very common and considered essential in some jurisdictions, is considered a recorded sex and gender entry.
package_name: hl7.fhir.r5.core
derivation: constraint
name: recordedSexOrGender
type: Extension
elements:
  extension:
    type: Extension
    short: The recorded sex or gender property for the individual
    index: 0
    slicing:
      slices:
        sourceField:
          match: {}
          schema:
            short: The name of the field within the source document where this sex or gender property is initially recorded.
            type: Extension
            index: 36
            extensions: {}
            elements:
              extension: {index: 37}
              url:
                type: uri
                pattern: {type: Uri, value: sourceField}
                index: 38
              value:
                choices: [valueString]
                index: 40
              valueString: {type: string, choiceOf: value, index: 41}
            required: [valueString, value]
        jurisdiction:
          match: {}
          schema:
            short: Who issued the document where the sex or gender was aquired
            type: Extension
            index: 42
            extensions: {}
            elements:
              extension: {index: 43}
              url:
                type: uri
                pattern: {type: Uri, value: jurisdiction}
                index: 44
              value:
                choices: [valueCodeableConcept]
                index: 46
              valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 47}
            required: [value, valueCodeableConcept]
        value:
          match: {}
          schema:
            type: Extension
            short: The recorded sex or gender property for the individual
            _required: true
            index: 0
            extensions: {}
            elements:
              extension: {index: 1}
              url:
                type: uri
                pattern: {type: Uri, value: value}
                index: 2
              value:
                choices: [valueCodeableConcept]
                index: 4
              valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 5}
            required: [value, valueCodeableConcept]
        type:
          match: {}
          schema:
            short: Type of recorded sex or gender.
            type: Extension
            index: 12
            extensions: {}
            elements:
              extension: {index: 13}
              url:
                type: uri
                pattern: {type: Uri, value: type}
                index: 14
              value:
                choices: [valueCodeableConcept]
                index: 16
              valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 17}
            required: [value, valueCodeableConcept]
        internationalEquivalent:
          match: {}
          schema:
            type: Extension
            short: An international representation of the value found on the document
            index: 6
            extensions: {}
            elements:
              extension: {index: 7}
              url:
                type: uri
                pattern: {type: Uri, value: internationalEquivalent}
                index: 8
              value:
                choices: [valueCodeableConcept]
                index: 10
              valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 11}
            required: [value, valueCodeableConcept]
        sourceDocument:
          match: {}
          schema:
            short: The document the sex or gender property was acquired from.
            type: Extension
            index: 30
            extensions: {}
            elements:
              extension: {index: 31}
              url:
                type: uri
                pattern: {type: Uri, value: sourceDocument}
                index: 32
              value:
                choices: [valueCodeableReference]
                index: 34
              valueCodeableReference: {type: CodeableReference, choiceOf: value, index: 35}
            required: [valueCodeableReference, value]
        comment:
          match: {}
          schema:
            type: Extension
            short: Context or source information about the recorded sex or gender
            index: 48
            extensions: {}
            elements:
              extension: {index: 49}
              url:
                type: uri
                pattern: {type: Uri, value: comment}
                index: 50
              value:
                choices: [valueString]
                index: 52
              valueString: {type: string, choiceOf: value, index: 53}
            required: [valueString, value]
        acquisitionDate:
          match: {}
          schema:
            type: Extension
            short: When the sex or gender value was recorded.
            index: 24
            extensions: {}
            elements:
              extension: {index: 25}
              url:
                type: uri
                pattern: {type: Uri, value: acquisitionDate}
                index: 26
              value:
                choices: [valueDateTime]
                index: 28
              valueDateTime: {type: dateTime, choiceOf: value, index: 29}
            required: [valueDateTime, value]
        effectivePeriod:
          match: {}
          schema:
            type: Extension
            short: When the recorded sex or gender value applies
            index: 18
            extensions: {}
            elements:
              extension: {index: 19}
              url:
                type: uri
                pattern: {type: Uri, value: effectivePeriod}
                index: 20
              value:
                choices: [valuePeriod]
                index: 22
              valuePeriod: {type: Period, choiceOf: value, index: 23}
  url:
    pattern: {type: Uri, value: 'http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender'}
    index: 54
  value:
    choices: []
    index: 56
package_version: 5.0.0-ballot
extensions:
  sourceField:
    url: null
    short: The name of the field within the source document where this sex or gender property is initially recorded.
    type: Extension
    index: 36
    extensions: {}
    elements:
      extension: {index: 37}
      url:
        type: uri
        pattern: {type: Uri, value: sourceField}
        index: 38
      value:
        choices: [valueString]
        index: 40
      valueString: {type: string, choiceOf: value, index: 41}
    required: [valueString, value]
  jurisdiction:
    url: null
    short: Who issued the document where the sex or gender was aquired
    type: Extension
    index: 42
    extensions: {}
    elements:
      extension: {index: 43}
      url:
        type: uri
        pattern: {type: Uri, value: jurisdiction}
        index: 44
      value:
        choices: [valueCodeableConcept]
        index: 46
      valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 47}
    required: [value, valueCodeableConcept]
  value:
    url: null
    type: Extension
    short: The recorded sex or gender property for the individual
    _required: true
    index: 0
    extensions: {}
    elements:
      extension: {index: 1}
      url:
        type: uri
        pattern: {type: Uri, value: value}
        index: 2
      value:
        choices: [valueCodeableConcept]
        index: 4
      valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 5}
    required: [value, valueCodeableConcept]
  type:
    url: null
    short: Type of recorded sex or gender.
    type: Extension
    index: 12
    extensions: {}
    elements:
      extension: {index: 13}
      url:
        type: uri
        pattern: {type: Uri, value: type}
        index: 14
      value:
        choices: [valueCodeableConcept]
        index: 16
      valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 17}
    required: [value, valueCodeableConcept]
  internationalEquivalent:
    url: null
    type: Extension
    short: An international representation of the value found on the document
    index: 6
    extensions: {}
    elements:
      extension: {index: 7}
      url:
        type: uri
        pattern: {type: Uri, value: internationalEquivalent}
        index: 8
      value:
        choices: [valueCodeableConcept]
        index: 10
      valueCodeableConcept: {type: CodeableConcept, choiceOf: value, index: 11}
    required: [value, valueCodeableConcept]
  sourceDocument:
    url: null
    short: The document the sex or gender property was acquired from.
    type: Extension
    index: 30
    extensions: {}
    elements:
      extension: {index: 31}
      url:
        type: uri
        pattern: {type: Uri, value: sourceDocument}
        index: 32
      value:
        choices: [valueCodeableReference]
        index: 34
      valueCodeableReference: {type: CodeableReference, choiceOf: value, index: 35}
    required: [valueCodeableReference, value]
  comment:
    url: null
    type: Extension
    short: Context or source information about the recorded sex or gender
    index: 48
    extensions: {}
    elements:
      extension: {index: 49}
      url:
        type: uri
        pattern: {type: Uri, value: comment}
        index: 50
      value:
        choices: [valueString]
        index: 52
      valueString: {type: string, choiceOf: value, index: 53}
    required: [valueString, value]
  acquisitionDate:
    url: null
    type: Extension
    short: When the sex or gender value was recorded.
    index: 24
    extensions: {}
    elements:
      extension: {index: 25}
      url:
        type: uri
        pattern: {type: Uri, value: acquisitionDate}
        index: 26
      value:
        choices: [valueDateTime]
        index: 28
      valueDateTime: {type: dateTime, choiceOf: value, index: 29}
    required: [valueDateTime, value]
  effectivePeriod:
    url: null
    type: Extension
    short: When the recorded sex or gender value applies
    index: 18
    extensions: {}
    elements:
      extension: {index: 19}
      url:
        type: uri
        pattern: {type: Uri, value: effectivePeriod}
        index: 20
      value:
        choices: [valuePeriod]
        index: 22
      valuePeriod: {type: Period, choiceOf: value, index: 23}
class: extension
kind: complex-type
url: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 5.0.0-ballot
required: [extension]