FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Patient Sex Parameter For Clinical Use (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Version: 5.2.0-ballot
Standards status: Draft Maturity Level: 1 Responsible: HL7 International / Patient Administration Computable Name: PatSexParameterForClinicalUse
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1347

A Sex Parameter for Clinical Use is a parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc.. This property is intended for use in clinical decision making, and indicates that treatment or diagnostic tests should consider best practices associated with the relevant reference population. When exchanging these concepts, refer to the guidance in the Gender Harmony Implementation Guide.

This is an experimental extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions.

Context of Use

This extension may be used on the following element(s):

  • Element ID Resource

Usage info

Usage:

Changes since version 1.0.0:

  • The resource metadata has changed (publisher)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • 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: A Sex Parameter for Clinical Use is a parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc.. This property is intended for use in clinical decision making, and indicates that treatment or diagnostic tests should consider best practices associated with the relevant reference population. When exchanging these concepts, refer to the guidance in the Gender Harmony Implementation Guide.

    • value: CodeableConcept: A parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc..
    • period: Period: The time period during which the sex parameter for clinical use applies
    • comment: string: Further explanation about the choice, intention, or context of use for the sex parameter for clinical use
    • supportingInfo: CodeableConcept, Reference: Other clinical evidence or documentation that was used to determine the sex parameter for clincal use

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A context-specific sex parameter for clinical use
    ... Slices for extension Content/Rules for all slices
    .... extension:value 1..1 Extension A context-specific sex parameter for clinical use
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Sex Parameter for Clinical Use (required)
    .... extension:period 0..1 Extension When the sex for clinical use applies
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    .... extension:supportingInfo 0..* Extension Source of the sex for clincal use
    ..... extension 0..0
    ..... url 1..1 uri "supportingInfo"
    ..... value[x] 1..1 Value of extension
    ...... valueCodeableConcept CodeableConcept
    ...... valueReference Reference(Resource)
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A context-specific sex parameter for clinical use
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:value 1..1 Extension A context-specific sex parameter for clinical use
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Sex Parameter for Clinical Use (required)
    .... extension:period 0..1 Extension When the sex for clinical use applies
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    .... extension:supportingInfo 0..* Extension Source of the sex for clincal use
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "supportingInfo"
    ..... value[x] 1..1 Value of extension
    ...... valueCodeableConcept CodeableConcept
    ...... valueReference Reference(Resource)
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: A Sex Parameter for Clinical Use is a parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc.. This property is intended for use in clinical decision making, and indicates that treatment or diagnostic tests should consider best practices associated with the relevant reference population. When exchanging these concepts, refer to the guidance in the Gender Harmony Implementation Guide.

    • value: CodeableConcept: A parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc..
    • period: Period: The time period during which the sex parameter for clinical use applies
    • comment: string: Further explanation about the choice, intention, or context of use for the sex parameter for clinical use
    • supportingInfo: CodeableConcept, Reference: Other clinical evidence or documentation that was used to determine the sex parameter for clincal use

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A context-specific sex parameter for clinical use
    ... Slices for extension Content/Rules for all slices
    .... extension:value 1..1 Extension A context-specific sex parameter for clinical use
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Sex Parameter for Clinical Use (required)
    .... extension:period 0..1 Extension When the sex for clinical use applies
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    .... extension:supportingInfo 0..* Extension Source of the sex for clincal use
    ..... extension 0..0
    ..... url 1..1 uri "supportingInfo"
    ..... value[x] 1..1 Value of extension
    ...... valueCodeableConcept CodeableConcept
    ...... valueReference Reference(Resource)
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension A context-specific sex parameter for clinical use
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:value 1..1 Extension A context-specific sex parameter for clinical use
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: Sex Parameter for Clinical Use (required)
    .... extension:period 0..1 Extension When the sex for clinical use applies
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "period"
    ..... value[x] 1..1 Period Value of extension
    .... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    .... extension:supportingInfo 0..* Extension Source of the sex for clincal use
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "supportingInfo"
    ..... value[x] 1..1 Value of extension
    ...... valueCodeableConcept CodeableConcept
    ...... valueReference Reference(Resource)
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:value.value[x]requiredSexParameterForClinicalUse
    http://terminology.hl7.org/ValueSet/sex-parameter-for-clinical-use

    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)