FHIR Extensions Pack
5.1.0-ballot1 - Ballot for Release 5.1.0 International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0-ballot: Releases Ballot 4) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 1.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: 5.1.0-ballot1
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Patient Administration Computable Name: RecordedSexOrGender
Other Identifiers: id: Uniform Resource Identifier (URI)#urn:oid:2.16.840.1.113883.4.642.5.1342

Recorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. 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

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: Recorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide.

    • value: CodeableConcept: A sex or gender property for the individual from a document or other record
    • type: CodeableConcept: The type or category of sex or gender that is recorded.
    • effectivePeriod: Period: The time period during which the recorded sex or gender value applies to the individual
    • acquisitionDate: dateTime: The date/time when the sex or gender value was first recorded in the system.
    • sourceDocument: CodeableReference: The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.
    • sourceField: string: The name of the field within the source document where this sex or gender property is initially recorded.
    • jurisdiction: CodeableConcept: The jurisdiction or organization that issued the document from which the sex or gender was aquired
    • comment: string: Further explanation about the context or source of the recorded sex or gender value

    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: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 (example)
    ... extension:effectivePeriod 0..1ExtensionWhen the recorded sex or gender value applies
    .... extension 0..0
    .... url 1..1uri"effectivePeriod"
    .... value[x] 0..1PeriodValue of extension
    .... 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 1..*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"type"
    .... value[x] 1..1CodeableConceptValue of extension
    Binding: Recorded Sex Or Gender Type (example)
    ... 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

    Complex Extension: Recorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide.

    • value: CodeableConcept: A sex or gender property for the individual from a document or other record
    • type: CodeableConcept: The type or category of sex or gender that is recorded.
    • effectivePeriod: Period: The time period during which the recorded sex or gender value applies to the individual
    • acquisitionDate: dateTime: The date/time when the sex or gender value was first recorded in the system.
    • sourceDocument: CodeableReference: The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.
    • sourceField: string: The name of the field within the source document where this sex or gender property is initially recorded.
    • jurisdiction: CodeableConcept: The jurisdiction or organization that issued the document from which the sex or gender was aquired
    • comment: string: Further explanation about the context or source of the recorded sex or gender value

    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: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 (example)
    ... extension:effectivePeriod 0..1ExtensionWhen the recorded sex or gender value applies
    .... extension 0..0
    .... url 1..1uri"effectivePeriod"
    .... value[x] 0..1PeriodValue of extension
    .... 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 1..*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"type"
    .... value[x] 1..1CodeableConceptValue of extension
    Binding: Recorded Sex Or Gender Type (example)
    ... 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:type.value[x]exampleRecordedSexOrGenderType
    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)