FHIR General Extensions IG
0.1.0 - Working Copy International flag

This page is part of the FHIR Core Extensions Registry (v0.1.0: Releases Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Extension: Person Recorded Sex Or Gender

Official URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: RecordedSexOrGender
Other Identifiers: id: urn:oid:2.16.840.1.113883.4.642.5.1342

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.

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:

  • This Extension is not used by any profiles in this Implementation Guide

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 (7 nested mandatory elements)
Fixed Value: 10 elements
Prohibited: 10 elements

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionA recorded sex or gender property for the individual
... extension:value 1..1ExtensionThe recorded sex or gender property for the individual
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AdministrativeGender (example)
... extension:internationalEquivalent 0..1ExtensionAn international representation of the value found on the document
.... extension 0..0
.... url 1..1uri"internationalEquivalent"
.... value[x] 1..1CodeableConcept​Value of extension
Binding: http://terminology.hl7.org/ValueSet/international-civil-aviation-organization-sex-or-gender (extensible)
... extension:type 0..1ExtensionType of recorded sex or gender.
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Recorded Sex Or Gender Type (preferred)
.... extension 0..0
.... url 1..1uri"effectivePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:acquisitionDate 0..1ExtensionWhen the sex or gender value was recorded.
.... extension 0..0
.... url 1..1uri"acquisitionDate"
.... value[x] 1..1dateTimeValue of extension
... extension:sourceDocument 0..1ExtensionThe document the sex or gender property was acquired from.
.... extension 0..0
.... url 1..1uri"sourceDocument"
.... value[x] 1..1CodeableReference(DocumentReference)Value of extension
... extension:sourceField 0..1ExtensionThe name of the field within the source document where this sex or gender property is initially recorded.
.... extension 0..0
.... url 1..1uri"sourceField"
.... value[x] 1..1stringValue of extension
... extension:jurisdiction 0..1ExtensionWho issued the document where the sex or gender was aquired
.... extension 0..0
.... url 1..1uri"jurisdiction"
.... value[x] 1..1CodeableConceptValue of extension
Binding: JurisdictionValueSet (extensible)
... extension:comment 0..1ExtensionContext or source information about the recorded sex or gender
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionA recorded sex or gender property for the individual
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:value 1..1ExtensionThe recorded sex or gender property for the individual
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AdministrativeGender (example)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"internationalEquivalent"
.... value[x] 1..1CodeableConcept​Value of extension
Binding: http://terminology.hl7.org/ValueSet/international-civil-aviation-organization-sex-or-gender (extensible)
... extension:type 0..1ExtensionType of recorded sex or gender.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Recorded Sex Or Gender Type (preferred)
... extension:effectivePeriod 0..1ExtensionWhen the recorded sex or gender value applies
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"effectivePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:acquisitionDate 0..1ExtensionWhen the sex or gender value was recorded.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"acquisitionDate"
.... value[x] 1..1dateTimeValue of extension
... extension:sourceDocument 0..1ExtensionThe document the sex or gender property was acquired from.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"sourceDocument"
.... value[x] 1..1CodeableReference(DocumentReference)Value of extension
... extension:sourceField 0..1ExtensionThe name of the field within the source document where this sex or gender property is initially recorded.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"sourceField"
.... value[x] 1..1stringValue of extension
... extension:jurisdiction 0..1ExtensionWho issued the document where the sex or gender was aquired
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"jurisdiction"
.... value[x] 1..1CodeableConceptValue of extension
Binding: JurisdictionValueSet (extensible)
... extension:comment 0..1ExtensionContext or source information about the recorded sex or gender
.... id 0..1idUnique 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/StructureDefinition/individual-recordedSexOrGender"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements (7 nested mandatory elements)
Fixed Value: 10 elements
Prohibited: 10 elements

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionA recorded sex or gender property for the individual
... extension:value 1..1ExtensionThe recorded sex or gender property for the individual
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AdministrativeGender (example)
... extension:internationalEquivalent 0..1ExtensionAn international representation of the value found on the document
.... extension 0..0
.... url 1..1uri"internationalEquivalent"
.... value[x] 1..1CodeableConcept​Value of extension
Binding: http://terminology.hl7.org/ValueSet/international-civil-aviation-organization-sex-or-gender (extensible)
... extension:type 0..1ExtensionType of recorded sex or gender.
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Recorded Sex Or Gender Type (preferred)
.... extension 0..0
.... url 1..1uri"effectivePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:acquisitionDate 0..1ExtensionWhen the sex or gender value was recorded.
.... extension 0..0
.... url 1..1uri"acquisitionDate"
.... value[x] 1..1dateTimeValue of extension
... extension:sourceDocument 0..1ExtensionThe document the sex or gender property was acquired from.
.... extension 0..0
.... url 1..1uri"sourceDocument"
.... value[x] 1..1CodeableReference(DocumentReference)Value of extension
... extension:sourceField 0..1ExtensionThe name of the field within the source document where this sex or gender property is initially recorded.
.... extension 0..0
.... url 1..1uri"sourceField"
.... value[x] 1..1stringValue of extension
... extension:jurisdiction 0..1ExtensionWho issued the document where the sex or gender was aquired
.... extension 0..0
.... url 1..1uri"jurisdiction"
.... value[x] 1..1CodeableConceptValue of extension
Binding: JurisdictionValueSet (extensible)
... extension:comment 0..1ExtensionContext or source information about the recorded sex or gender
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionA recorded sex or gender property for the individual
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:value 1..1ExtensionThe recorded sex or gender property for the individual
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AdministrativeGender (example)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"internationalEquivalent"
.... value[x] 1..1CodeableConcept​Value of extension
Binding: http://terminology.hl7.org/ValueSet/international-civil-aviation-organization-sex-or-gender (extensible)
... extension:type 0..1ExtensionType of recorded sex or gender.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Recorded Sex Or Gender Type (preferred)
... extension:effectivePeriod 0..1ExtensionWhen the recorded sex or gender value applies
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"effectivePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:acquisitionDate 0..1ExtensionWhen the sex or gender value was recorded.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"acquisitionDate"
.... value[x] 1..1dateTimeValue of extension
... extension:sourceDocument 0..1ExtensionThe document the sex or gender property was acquired from.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"sourceDocument"
.... value[x] 1..1CodeableReference(DocumentReference)Value of extension
... extension:sourceField 0..1ExtensionThe name of the field within the source document where this sex or gender property is initially recorded.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"sourceField"
.... value[x] 1..1stringValue of extension
... extension:jurisdiction 0..1ExtensionWho issued the document where the sex or gender was aquired
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"jurisdiction"
.... value[x] 1..1CodeableConceptValue of extension
Binding: JurisdictionValueSet (extensible)
... extension:comment 0..1ExtensionContext or source information about the recorded sex or gender
.... id 0..1idUnique 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/StructureDefinition/individual-recordedSexOrGender"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:value.value[x]exampleAdministrativeGender
Extension.extension:internationalEquivalent.value[x]extensible​http://terminology.hl7.org/ValueSet/international-civil-aviation-organization-sex-or-gender
Extension.extension:type.value[x]preferredRecordedSexOrGenderType
Extension.extension:jurisdiction.value[x]extensibleJurisdictionValueSet

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

(none found)

;