Page History

Systems that support ODM Clinical Data Import clinical data import will need to specify how they handle NullFlavors NullFlavor values in ODM-XML documents. Systems that generate ODM Clinical Data Exports will clinical data exports will need to specify whether or not they include Null Flavor NullFlavor information.

Info

title	Null Flavor informative content

The clinical trials data collection process includes standardized practices for managing incomplete subject data. Most subject data is gathered through interactions with health care healthcare professionals though , although some is entered directly by humans human subjects. HL7 has developed a standard set of Null Flavor NullFlavor codes represented in an ISO 21090 enumeration. Clinical study records extracted directly from healthcare records may encounter this coding.

NullFlavors NullFlavor values are indicated in ODM Clinical Data clinical data through the use of a NullFlavor Annotation.

A NullFlavor Annotation is an ODM Annotation element with a Flag child element with a codelist reference. The referenced codelist defines the set of NullFlavors of NullFlavor values supported for the study. The Annotation element can be used at any level in the ODM clinical data hierarchy. For ODM V2 that means With ODM v2.0, this means that it can be used with the StudyEventData, ItemGroupData, or ItemData elements.

For studies that support collection of NullFlavor information, the ODM MetaDataVersion must include a CodeList a CodeList element to identify the set of NullFlavors NullFlavor values that are handledallowed. For the use case where the study study data will be sourced by electronic health records using Fast Healthcare Interoperability Resources (FHIR resources), NullFlavors NullFlavor values will be taken from the HL7 Version 3 Null Flavor Value set or NullFlavor Value Set (https://www.healthit.gov/sites/default/files/170299_f_29_hl7_v3_agender_and_nullflavor.pdf) or a defining value subset, .

When the value of a variable cannot be collected, the ItemData element will have the IsNull attribute set to "Yes" and an Annotation child element that provides the applicable NullValue Code.

When a StudyEvent identified in a data request or study workflow does not occur, a Null Value NullValue Annotation will be provided as a child element of the StudyEventData element. If a Form/Data Collection Instrument is skipped or has no values entered, the Null Value NullValue Annotation is provided as a child element of the ItemGroupData element.

See HL7, Defining Value Sets, http://build.fhir.org/ig/HL7/fhir-shorthand/reference.html#defining-value-sets; and ValueSet: NullFlavor, https://terminology.hl7.org/2.0.0/ValueSet-v3-NullFlavor.

Examples

Example 1: Support for a

...

prespecified set of null flavors

The study metadata includes a 2 CodeList elements with the list of support null flavor values. The first CodeList, Name="NullFlavorValueSubset", is referenced in the rest of the code blocks on this page. The second CodeList, Name="NullFlavorValueSubset2", is provided to illustrate a specific definition of the HL7 Null Flavor code "MSK" for a blinded study.

The CodeListItem definitions provide the Null Flavor codes as the CodedValue attribute. The Decode provides a label value that could be displayed on a CRF or in an analysis display, as intended to be used in the study.

Refer to the notes about the meaning of Decode in Sections 3.2.2.1.7, Coding, and 3.2.2.1.13, CodeListItem.

Code Block

language	xml
title	Null Flavor Subset Codelist Definition
linenumbers	true

<MetaDataVersion OID="ODMV2.MDV.NF">
    <CodeList OID="STUDY.CL.NullReasonCodelist" Name="NullFlavorValueSubset" DataType="text">
        <CodeListItem CodedValue="MSK">
            <Decode>
                <TranslatedText xml:lang="en">masked<>Masked</TranslatedText>
            </Decode>
        </CodeListItem>
        <CodeListItem CodedValue="NA">
            <Decode>
                <TranslatedText>Not Applicable</TranslatedText>
            </Decode>
        </CodeListItem>
        <CodeListItem CodedValue="NAV">
            <Decode>
                <TranslatedText>Temporarily Unavailable</TranslatedText>
       <TranslatedText>temporarily unavailable<     </Decode>
        </CodeListItem>
        <CodeListItem CodedValue="NI">
            <Decode>
                <TranslatedText>No Data Present</TranslatedText>
            </Decode>
        </CodeListItem>
        <Coding Code="V3 Null Flavor Value Set" System="https://terminology.hl7.org/2.0.0/ValueSet-v3-NullFlavor.html"
            SystemName="v3.NullFlavor" SystemVersion="2018-08-12"/>
    </CodeList>
    <CodeList OID="STUDY.CL.NullReasonCodelist2" Name="NullFlavorValueSubset2" DataType="text">
        <CodeListItem CodedValue=" CommentOID="ODMV2EX.WhyNoHrefMSK">
            <Decode>
                <TranslatedText xml:lang="en">Blinded</TranslatedText>
            </Decode>
        </CodeListItem>
        <Coding Code="V3 Null Flavor Value Set" System="https://terminology.hl7.org/2.0.0/ValueSet-v3-NullFlavor.html"
            SystemName="v3.NullFlavor" SystemVersion="2018-08-12"/>
    </CodeList>
</MetaDataVersion>

In the ODM ClinicalData element, ItemData elements where IsNull is "Yes" include an Annotation element with a Flag element with the CodeListOID attribute set to to "STUDY.CL.NullReasonCodelist", the OID of the NullFlavorValueSet codelist.

The Annotation element appears following the AuditRecord element.

Code Block

language	xml
firstline	1
title	Null Flavors Reference Example 1
linenumbers	true

 <ClinicalData StudyOID="ODMV2.NF.EX1.Study" MetaDataVersonOID="ODMV2.NF.EX1.MDV">
    <SubjectData SubjectKey="001" TransactionType="Insert">
        <StudyEventData StudyEventOID="vstBASE">
            <ItemGroupData ItemGroupOID="sfrmDM">
                <ItemData ItemOID="svarFHMarriage" IsNull="Yes">
                    <AuditRecord>
                        <UserRef UserOID="system"/>
                        <LocationRef LocationOID="PhaseForwardCDISC"/>
                        <DateTimeStamp>2008-03-17T19:21:58+00:00</DateTimeStamp>
                    </AuditRecord>
                    <Annotation SeqNum="67944">
                                    <Flag <Flag><FlagValue CodeListOID="STUDY.CL.NullReasonCodelist">Not Applicable<>NA</FlagValue></Flag>
                            <   </Annotation>
                </ItemData>
            </ItemGroupData>
        </StudyEventData>
        <StudyEventData StudyEventOID="vstWEEK1">
            <ItemGroupData ItemGroupOID="sfmECG">
                <AuditRecord>
                    <UserRef UserOID="system"/>
                    <LocationRef LocationOID="PhaseForwardCDISC"/>
                    <DateTimeStamp>2008-03-17T1924T19:21:58+00:00</DateTimeStamp>
                </AuditRecord>
                <Annotation SeqNum="67944">
                    <Flag <Flag><FlagValue CodeListOID="STUDY.CL.NullReasonCodelist">Masked<>MSK</FlagValue></Flag>
                      <   </Annotation>
            </ItemGroupData>
        </StudyEventData>
    </SubjectData>
</ClinicalData>

Example 2: Allow any values from HL7 Null Flavor Value Set

The CodeList definition uses an an ExternalCodeList element to identify the dictionary and version. The Coding element provides the URI for the HL7 Null Flavor ValuelistValue Set.

Code Block

title	MetaData Null Flavors Example 2Complete Codelist Definition
linenumbers	true

<MetaDataVersion OID="ODMV2.NF.EX2.MDV">
    <!-- Study Event, ItemGroup and Item definitions not shown -->
    <CodeList OID="STUDY.CL.NullReasonCodelist" Name="NullFlavorValueSubsetNullFlavorValueSet" DataType="text">
        <ExternalCodeList Dictionary="HL7 Null Flavor Value Set" Version="2018-08-12"/>
        <Coding Code="V3 Null Flavor Value Set" System="https://terminology.hl7.org/2.0.0/ValueSet-v3-NullFlavor.html"
            SystemName="v3.NullFlavor" SystemVersion="2018-08-12" CommentOID="ODMV2EX.WhyNoHref"/>
    </CodeList>
</MetaDataVersion>

The ClinicalData element illustrates the use of Null Flavor Annotation for an ItemGroupData (form) where no clinical data is included . (i.e, not present in the data). The Flag element within the Annotation provides the null value code NI, with a Display="NoInformation" in the HL7 definition. Note in this case there is no display value explicitly included in the study metadata definition.

The Annotation element appears following the AuditRecord element.

Code Block

language	xml
title	Ex2 Clinical DataNull Flavors Reference Example 2
linenumbers	true

<ClinicalData StudyOID="ODMV2.NF.EX2.Study" MetaDataVersonOID="ODMV2.NF.EX2.MDV">
    <SubjectData SubjectKey="002" TransactionType="Insert">
        <StudyEventData StudyEventOID="vstWEEK3">
            <ItemGroupData ItemGroupOID="sfrmLB-biomarker">
                <AuditRecord>
                    <UserRef UserOID="system"/>
                    <LocationRef LocationOID="UCSDCDISC"/>
                    <DateTimeStamp>2019-03-17T19:21:58+00:00</DateTimeStamp>
                </AuditRecord>
                <Annotation SeqNum="67944">
                    <Flag<Flag><FlagValue CodeListOID="STUDY.CL.NullReasonCodelist">NI</FlagValue></Flag>
                      <   </Annotation>
            </ItemGroupData>
        </StudyEventData>
    </SubjectData>
</ClinicalData>

References

V3 Null Flavor Value Set	https://terminology.hl7.org/2.0.0/ValueSet-v3-NullFlavor
FHIR Shorthand (FSH) for Code Subset Definitions	http://build.fhir.org/ig/HL7/fhir-shorthand/reference.html#defining-value-sets

Pagenav2

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Examples

Example 1: Support for a

prespecified set of null flavors

Example 2: Allow any values from HL7 Null Flavor Value Set

References