CodeableConcept.profile.xml

StructureDefinition for CodeableConcept

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="CodeableConcept"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/CodeableConcept"/>
  <name value="CodeableConcept"/>
  <publisher value="HL7 FHIR Standard"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for CodeableConcept Resource"/>
  <requirements value="This is a common pattern in healthcare - a concept that may be defined by one or more
   codes from formal definitions including LOINC and SNOMED CT, and/or defined by the provision
   of text that captures a human sense of the concept."/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="type"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <snapshot>
    <element>
      <path value="CodeableConcept"/>
      <short value="Concept - reference to a terminology or just  text"/>
      <definition value="A concept that may be defined by a formal reference to a terminology or ontology or may
       be provided by text."/>
      <comments value="Not all terminology uses fit this general pattern. In some cases, models should not use
       CodeableConcept and use Coding directly and provide their own structure for managing text,
       codings, translations and the relationship between elements and pre- and post-coordination."/>
      <requirements value="This is a common pattern in healthcare - a concept that may be defined by one or more
       codes from formal definitions including LOINC and SNOMED CT, and/or defined by the provision
       of text that captures a human sense of the concept."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <constraint>
        <key value="ccc-2"/>
        <name value="Coding.primary rule"/>
        <severity value="error"/>
        <human value="Only one coding in a set can be chosen directly by the user"/>
        <xpath value="count(f:coding[f:primary/@value='true'])&lt;=1"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="CE/CNE/CWE"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="CD"/>
      </mapping>
    </element>
    <element>
      <path value="CodeableConcept.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="CodeableConcept.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="CodeableConcept.coding"/>
      <short value="Code defined by a terminology system"/>
      <definition value="A reference to a code defined by a terminology system."/>
      <comments value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions
       such as SNOMED CT - see the V3 Core Principles for more information.  Ordering of codings
       is undefined and SHALL not be used to infer meaning."/>
      <requirements value="Allows for translations and alternate encodings within a code system.  Also supports communication
       of the same instance to systems requiring different encodings."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="C*E.1-8, C*E.10-22"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="union(., ./translation)"/>
      </mapping>
    </element>
    <element>
      <path value="CodeableConcept.text"/>
      <short value="Plain text representation of the concept"/>
      <definition value="A human language representation of the concept as seen/selected/uttered by the user who
       entered the data and/or which represents the intended meaning of the user."/>
      <comments value="Very often the text is the same as a displayName of one of the codings."/>
      <requirements value="The codes from the terminologies do not always capture the correct meaning with all the
       nuances of the human using them, or sometimes there is no appropriate code at all. In
       these cases, the text is used to capture the full meaning of the source."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="C*E.9. But note many systems use C*E.2 for this"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./originalText[mediaType/code=&quot;text/plain&quot;]/data"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="CodeableConcept"/>
      <short value="Concept - reference to a terminology or just  text"/>
      <definition value="A concept that may be defined by a formal reference to a terminology or ontology or may
       be provided by text."/>
      <comments value="Not all terminology uses fit this general pattern. In some cases, models should not use
       CodeableConcept and use Coding directly and provide their own structure for managing text,
       codings, translations and the relationship between elements and pre- and post-coordination."/>
      <requirements value="This is a common pattern in healthcare - a concept that may be defined by one or more
       codes from formal definitions including LOINC and SNOMED CT, and/or defined by the provision
       of text that captures a human sense of the concept."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Element"/>
      </type>
      <constraint>
        <key value="ccc-2"/>
        <name value="Coding.primary rule"/>
        <severity value="error"/>
        <human value="Only one coding in a set can be chosen directly by the user"/>
        <xpath value="count(f:coding[f:primary/@value='true'])&lt;=1"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="CE/CNE/CWE"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="CD"/>
      </mapping>
    </element>
    <element>
      <path value="CodeableConcept.coding"/>
      <short value="Code defined by a terminology system"/>
      <definition value="A reference to a code defined by a terminology system."/>
      <comments value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions
       such as SNOMED CT - see the V3 Core Principles for more information.  Ordering of codings
       is undefined and SHALL not be used to infer meaning."/>
      <requirements value="Allows for translations and alternate encodings within a code system.  Also supports communication
       of the same instance to systems requiring different encodings."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="C*E.1-8, C*E.10-22"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="union(., ./translation)"/>
      </mapping>
    </element>
    <element>
      <path value="CodeableConcept.text"/>
      <short value="Plain text representation of the concept"/>
      <definition value="A human language representation of the concept as seen/selected/uttered by the user who
       entered the data and/or which represents the intended meaning of the user."/>
      <comments value="Very often the text is the same as a displayName of one of the codings."/>
      <requirements value="The codes from the terminologies do not always capture the correct meaning with all the
       nuances of the human using them, or sometimes there is no appropriate code at all. In
       these cases, the text is used to capture the full meaning of the source."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="C*E.9. But note many systems use C*E.2 for this"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./originalText[mediaType/code=&quot;text/plain&quot;]/data"/>
      </mapping>
    </element>
  </differential>
</StructureDefinition>