Uploaded image for project: 'Other Specification Feedback'
  1. Other Specification Feedback
  2. OTHER-2479

Recorded Sex or Gender template lacks value set binding

    XMLWordPrintableJSON

Details

    • Change Request
    • Resolution: Persuasive with Modification
    • Medium
    • Cross-Paradigm Gender Harmony (OTHER)
    • Terminology Infrastructure
    • 2.3 Recorded Sex or Gender Template
    • Hide

      Current 

      1. SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4536-84).
        2. SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4536-85).
        3. SHALL contain exactly one [1..1] templateId (CONF:4536-86) such that it
            a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.15.4" (CONF:4536-87).
            b. SHALL contain exactly one [1..1] @extension="2022-09-01" (CONF:4536-88).
        4. SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 (CONF:4536- 89).
            a. This code SHALL contain exactly one [1..1] @code="99502-7" Recorded sex or gender (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:4536-97). 
            originalText is the name of the field in the source document.
            b. This code MAY contain zero or one [0..1] originalText (CONF:4536-90).
            derivationExpr is used to record the algorithm or rationale for the assignment.
        5. MAY contain zero or one [0..1] derivationExpr (CONF:4536-141).
        6. MAY contain zero or one [0..1] text (CONF:4536-91).
        7. SHALL contain exactly one [1..1] statusCode="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4536-92).
        8. MAY contain zero or one [0..1] effectiveTime (CONF:4536-94).
            The value element should contain the recorded sex or gender value. If it is encoded, the code and system should be captured; if it is from a document, it's likely it will consist of originalText only.
        9. SHALL contain exactly one [1..1] value with @xsi:type="CE" (CONF:4536-93).
            a. This value MAY contain zero or one [0..1] translation (ValueSet: international-civil-aviation-organization-sex-or-gender urn:oid:2.16.840.1.113883.11.19756) (CONF:4536-95).

      Proposed

      1. SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4536-84).
        2. SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4536-85).
        3. SHALL contain exactly one [1..1] templateId (CONF:4536-86) such that it
            a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.15.4" (CONF:4536-87).
            b. SHALL contain exactly one [1..1] @extension="2022-09-01" (CONF:4536-88).
        4. SHALL contain exactly one [1..1] code (CONF:###).
            a. This code SHALL contain exactly one [1..1] @code="99502-7" Recorded sex or gender (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:4536-97).    
        9. SHALL contain exactly one [1..1] value with @xsi:type="CE" (CONF:4536-93)
            a. This code MAY contain zero or one [0..1] originalText (CONF:4536-90), originalText is the value of the field from the source document.

       
      Some Scenarios to included in template
      We have a code value from some value set/code system such as ValueSet Administrative Gender 
       <value xsi:type="CE" code="female" displayName="Female" codeSystem="2.16.840.1.113883.4.642.1.2">
               <translation code="F" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Female"/>
              <originalText>Female</originalText> <!-- The general purpose of hte originalText is to provide a option given to the user when encoding -->
      </value>
       
      Using snomed
       
      <value xsi:type="CE" code="446151000124109" displayName="Identifies as male gender (finding) Male" codeSystem="???">
               <translation code="M" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Male"/>
              <originalText>Male Gender</originalText> <!-- The general purpose of hte originalText is to provide a option given to the user when encoding -->
      </value>
       
      Local code system
      <value xsi:type="CE" code="LOCALFEMALE" codeSystem="LOCALCODESYSTEM">
               <translation code="F" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Female"/>
              <originalText>Fem</originalText>
      </value>
       
       General Text ( no local or other code system)
       
      <value>
               <translation code="M" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Male"/>
              <originalText>MALE</originalText> <!-- The general purpose of hte originalText is to provide a option given to the user when encoding -->
      </value>
       
      As an overal expectation - there will always be enough information to populate the transformation
      Consuming systems can investigate the use of the value code and if no known coding system value provided rely on the translations code system of International Civil Aviation Organization Sex or Gender
       

      Show
      Current  SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4536-84). 2. SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4536-85). 3. SHALL contain exactly one [1..1] templateId (CONF:4536-86) such that it     a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.15.4" (CONF:4536-87).     b. SHALL contain exactly one [1..1] @extension="2022-09-01" (CONF:4536-88). 4. SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 (CONF:4536- 89).     a. This code SHALL contain exactly one [1..1] @code="99502-7" Recorded sex or gender (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:4536-97).      originalText is the name of the field in the source document.     b. This code MAY contain zero or one [0..1] originalText (CONF:4536-90).     derivationExpr is used to record the algorithm or rationale for the assignment. 5. MAY contain zero or one [0..1] derivationExpr (CONF:4536-141). 6. MAY contain zero or one [0..1] text (CONF:4536-91). 7. SHALL contain exactly one [1..1] statusCode="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4536-92). 8. MAY contain zero or one [0..1] effectiveTime (CONF:4536-94).     The value element should contain the recorded sex or gender value. If it is encoded, the code and system should be captured; if it is from a document, it's likely it will consist of originalText only. 9. SHALL contain exactly one [1..1] value with @xsi:type="CE" (CONF:4536-93).     a. This value MAY contain zero or one [0..1] translation (ValueSet: international-civil-aviation-organization-sex-or-gender urn:oid:2.16.840.1.113883.11.19756) (CONF:4536-95). Proposed SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4536-84). 2. SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4536-85). 3. SHALL contain exactly one [1..1] templateId (CONF:4536-86) such that it     a. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.15.4" (CONF:4536-87).     b. SHALL contain exactly one [1..1] @extension="2022-09-01" (CONF:4536-88). 4. SHALL contain exactly one [1..1] code (CONF:###).     a. This code SHALL contain exactly one [1..1] @code="99502-7" Recorded sex or gender (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:4536-97).     9. SHALL contain exactly one [1..1] value with @xsi:type="CE" (CONF:4536-93)     a. This code MAY contain zero or one [0..1] originalText (CONF:4536-90), originalText is the value of the field from the source document.   Some Scenarios to included in template We have a code value from some value set/code system such as ValueSet Administrative Gender   <value xsi:type="CE" code="female" displayName="Female" codeSystem="2.16.840.1.113883.4.642.1.2">          <translation code="F" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Female"/>         <originalText>Female</originalText> <!-- The general purpose of hte originalText is to provide a option given to the user when encoding --> </value>   Using snomed   <value xsi:type="CE" code="446151000124109" displayName="Identifies as male gender (finding) Male" codeSystem="???">          <translation code="M" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Male"/>         <originalText>Male Gender</originalText> <!-- The general purpose of hte originalText is to provide a option given to the user when encoding --> </value>   Local code system <value xsi:type="CE" code="LOCALFEMALE" codeSystem="LOCALCODESYSTEM">          <translation code="F" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Female"/>         <originalText>Fem</originalText> </value>    General Text ( no local or other code system)   <value>          <translation code="M" codeSystem="2.16.840.1.113883.11.19756" codeSystemName="International Civil Aviation Organization Sex or Gender" displayName="Male"/>         <originalText>MALE</originalText> <!-- The general purpose of hte originalText is to provide a option given to the user when encoding --> </value>   As an overal expectation - there will always be enough information to populate the transformation Consuming systems can investigate the use of the value code and if no known coding system value provided rely on the translations code system of International Civil Aviation Organization Sex or Gender  
    • Clarification
    • Compatible, substantive

    Description

      The Recorded Sex or Gender template has:

      9. SHALL contain exactly one [1..1] value with @xsi:type="CE" (CONF:4536-93).
      a. This value MAY contain zero or one [0..1] translation (ValueSet: international-civil-aviation-organization-sex-or-gender
      urn:oid:2.16.840.1.113883.11.19756) (CONF:4536-95).

      1) Which value set should the value come from? Can we at least pick one that it SHOULD use?
      2) It MAY have [0..1] translation, but what's the relationship between that translation and the suggested value set? Presumably we mean to say it MAY come from that value set? (Hopefully not SHALL...)

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              mszczepa Matt Szczepankiewicz
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: