STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Ccda/CR.xml

Raw XML (canonical form)

Logical Model V3 Data type CR (ConceptRole)

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="CR"/>
  <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <url value="http://hl7.org/fhir/StructureDefinition/CR"/>
  <name value="V3 Data type CR (ConceptRole)"/>
  <display value="V3 Data type CR (ConceptRole)"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="HL7"/>
  <description value="A concept qualifier code with optionally named role. Both qualifier role and value codes
   must be defined by the coding system of the CD containing the concept qualifier. For example,
   if SNOMED RT defines a concept &quot;leg&quot;, a role relation &quot;has-laterality&quot;,
   and another concept &quot;left&quot;, the concept role relation allows to add the qualifier
   &quot;has-laterality: left&quot; to a primary code &quot;leg&quot; to construct the meaning
   &quot;left leg&quot;."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ANY"/>
  <snapshot>
    <element>
      <path value="CR"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="CR.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper
       information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-NullFlavor"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="CR.name"/>
      <label value="Name"/>
      <definition value="Specifies the manner in which the concept role value contributes to the meaning of a code
       phrase. For example, if SNOMED RT defines a concept &quot;leg&quot;, a role relation &quot;has-later
      ality&quot;, and another concept &quot;left&quot;, the concept role relation allows to
       add the qualifier &quot;has-laterality: left&quot; to a primary code &quot;leg&quot; to
       construct the meaning &quot;left leg&quot;. In this example &quot;has-laterality&quot;
       is the CR.name."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CV"/>
      </type>
    </element>
    <element>
      <path value="CR.value"/>
      <label value="Value"/>
      <definition value="The concept that modifies the primary code of a code phrase through the role relation.
       For example, if SNOMED RT defines a concept &quot;leg&quot;, a role relation &quot;has-laterality&qu
      ot;, and another concept &quot;left&quot;, the concept role relation allows adding the
       qualifier &quot;has-laterality: left&quot; to a primary code &quot;leg&quot; to construct
       the meaning &quot;left leg&quot;. In this example &quot;left&quot; is the CR.value."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CD"/>
      </type>
    </element>
    <element>
      <path value="CR.inverted"/>
      <representation value="xmlAttr"/>
      <label value="Inversion Indicator"/>
      <definition value="Indicates if the sense of the role name is inverted. This can be used in cases where the
       underlying code system defines inversion but does not provide reciprocal pairs of role
       names. By default, inverted is false."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="BN"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="CR"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="CR.name"/>
      <label value="Name"/>
      <definition value="Specifies the manner in which the concept role value contributes to the meaning of a code
       phrase. For example, if SNOMED RT defines a concept &quot;leg&quot;, a role relation &quot;has-later
      ality&quot;, and another concept &quot;left&quot;, the concept role relation allows to
       add the qualifier &quot;has-laterality: left&quot; to a primary code &quot;leg&quot; to
       construct the meaning &quot;left leg&quot;. In this example &quot;has-laterality&quot;
       is the CR.name."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CV"/>
      </type>
    </element>
    <element>
      <path value="CR.value"/>
      <label value="Value"/>
      <definition value="The concept that modifies the primary code of a code phrase through the role relation.
       For example, if SNOMED RT defines a concept &quot;leg&quot;, a role relation &quot;has-laterality&qu
      ot;, and another concept &quot;left&quot;, the concept role relation allows adding the
       qualifier &quot;has-laterality: left&quot; to a primary code &quot;leg&quot; to construct
       the meaning &quot;left leg&quot;. In this example &quot;left&quot; is the CR.value."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CD"/>
      </type>
    </element>
    <element>
      <path value="CR.inverted"/>
      <representation value="xmlAttr"/>
      <label value="Inversion Indicator"/>
      <definition value="Indicates if the sense of the role name is inverted. This can be used in cases where the
       underlying code system defines inversion but does not provide reciprocal pairs of role
       names. By default, inverted is false."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="BN"/>
      </type>
    </element>
  </differential>
</StructureDefinition>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.