US Public Health Profiles Library
1.0.0-ballot - STU Ballot US

This page is part of the US Public Health Profiles Library (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Extension: US Public Health Gender Identity Extension

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-genderidentity-extension Version: 1.0.0-ballot
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):

  • Patient
  • RelatedPerson
  • Person
  • 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

Mandatory: 2 elements (2 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements

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 0..*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/ph-library/StructureDefinition/us-ph-genderidentity-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements

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 0..*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/ph-library/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]preferredGender Identity

Constraints

IdGradePathDetailsRequirements
ele-1errorExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:valueMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:value.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:periodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:period.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:commentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:commentMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:comment.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())