FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Individual Gender Identity

Official URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Patient Administration Computable Name: PGenderIdentity
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1336

An individual’s personal sense of being a man, woman, boy, girl, nonbinary, or something else. This represents an individual’s identity, ascertained by asking them what that identity is. In the case where the gender identity is communicated by a third party, for example, if a spouse indicates the gender identity of their partner on an intake form, a Provenance resource can be used with a Provenance.target referring to the Patient, with a targetElement extension identifying the gender identity extension as the target element within the Patient resource. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide.

Context of Use

This extension may be used on the following element(s):

  • Element ID Patient
  • Element ID RelatedPerson
  • Element ID Person
  • Element ID Practitioner
  • Element ID PractitionerRole

Usage info

Usage:

Changes since version 1.0.0:

  • The resource metadata has changed (status, publisher)

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else. This represents an individual’s identity, ascertained by asking them what that identity is. In the case where the gender identity is communicated by a third party, for example, if a spouse indicates the gender identity of their partner on an intake form, a Provenance resource can be used with a Provenance.target referring to the Patient, with a targetElement extension identifying the gender identity extension as the target element within the Patient resource. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide.

    • value: CodeableConcept: An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.
    • period: Period: The time period during which the gender identity applies to the individual
    • comment: string: Text to further explain the use of the specified gender identity

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension The individual's gender identity
    ... Slices for extension Content/Rules for all slices
    .... extension:value 1..1 Extension The individual's gender identity
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Gender Identity (preferred)
    .... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension The individual's gender identity
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:value 1..1 Extension The individual's gender identity
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Gender Identity (preferred)
    .... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else. This represents an individual’s identity, ascertained by asking them what that identity is. In the case where the gender identity is communicated by a third party, for example, if a spouse indicates the gender identity of their partner on an intake form, a Provenance resource can be used with a Provenance.target referring to the Patient, with a targetElement extension identifying the gender identity extension as the target element within the Patient resource. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide.

    • value: CodeableConcept: An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.
    • period: Period: The time period during which the gender identity applies to the individual
    • comment: string: Text to further explain the use of the specified gender identity

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension The individual's gender identity
    ... Slices for extension Content/Rules for all slices
    .... extension:value 1..1 Extension The individual's gender identity
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Gender Identity (preferred)
    .... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension The individual's gender identity
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:value 1..1 Extension The individual's gender identity
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Gender Identity (preferred)
    .... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:value.value[x]preferredGenderIdentity
    http://terminology.hl7.org/ValueSet/gender-identity

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension