HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.1 - STU 2.1.1 United States of America flag

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Extension: US Public Health Gender Identity Extension

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension Version: 2.1.1
Active as of 2022-05-24 Computable Name: USPublicHealthGenderIdentityExtension

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

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. This is a copy of the draft FHIR individual-genderIdentity extension (http://hl7.org/fhir/StructureDefinition/individual-genderIdentity).

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

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

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. This is a copy of the draft FHIR individual-genderIdentity extension (http://hl7.org/fhir/StructureDefinition/individual-genderIdentity).

  • 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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionThe individual's gender identity
... extension:value 1..1ExtensionThe individual's gender identity
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (preferred)
... extension:period 0..1ExtensionThe time period during which the gender identity applies to the individual
.... extension 0..0
.... url 1..1uri"period"
.... value[x] 1..1PeriodValue of extension
... extension:comment 0..1ExtensionText to further explain the use of the specified gender identity
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionThe individual's gender identity
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:value 1..1ExtensionThe individual's gender identity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"period"
.... value[x] 1..1PeriodValue of extension
... extension:comment 0..1ExtensionText to further explain the use of the specified gender identity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension"

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. This is a copy of the draft FHIR individual-genderIdentity extension (http://hl7.org/fhir/StructureDefinition/individual-genderIdentity).

  • 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

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionThe individual's gender identity
... extension:value 1..1ExtensionThe individual's gender identity
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (preferred)
... extension:period 0..1ExtensionThe time period during which the gender identity applies to the individual
.... extension 0..0
.... url 1..1uri"period"
.... value[x] 1..1PeriodValue of extension
... extension:comment 0..1ExtensionText to further explain the use of the specified gender identity
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionThe individual's gender identity
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:value 1..1ExtensionThe individual's gender identity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"period"
.... value[x] 1..1PeriodValue of extension
... extension:comment 0..1ExtensionText to further explain the use of the specified gender identity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-genderidentity-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:value.value[x]preferredGenderIdentity

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