US Core Implementation Guide
7.0.0-ballot - Ballot United States of America flag

This page is part of the US Core (v7.0.0-ballot: STU7 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.1.0. For a full list of available versions, see the Directory of published versions

Extension: US Core Gender Identity Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Version: 7.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreGenderIdentityExtension

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

This extension represents an individual’s sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates SHOULD use the FHIR R5 genderIdentity extension. When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.

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

Profile specific implementation guidance

  • This extension provides concepts to describe the gender a person identifies as. This extension is not used to describe a person’s sexual orientation (who they are attracted to).

  • The concepts included here are from the HL7 Gender Harmony Project which is modeling gender and sex information data elements, value sets, code systems.

  • A gender-identity search parameter has been defined for this extension. However, there are no gender-identity search requirements for the client or server.

Usage info

Usage:

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

Simple Extension of type CodeableConcept: This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates SHOULD use the FHIR R5 genderIdentity extension. When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
... value[x] 0..1CodeableConceptValue of extension
Binding: Gender Identity (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
... value[x] 0..1CodeableConceptValue of extension
Binding: Gender Identity (extensible)

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type CodeableConcept: This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates SHOULD use the FHIR R5 genderIdentity extension. When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
... value[x] 0..1CodeableConceptValue of extension
Binding: Gender Identity (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
... value[x] 0..1CodeableConceptValue of extension
Binding: Gender Identity (extensible)

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.value[x]extensibleGenderIdentity

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()