International Patient Summary Implementation Guide Implementation Guide: STU2 Ballot

This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

JSON Format: StructureDefinition-codeableconcept-uv-ips

Raw json

{
  "resourceType" : "StructureDefinition",
  "id" : "codeableconcept-uv-ips",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-codeableconcept-uv-ips-definitions.html#CodeableConcept.coding" title="null">coding</a><a name="CodeableConcept.coding"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-coding-uv-ips.html" title="Coding">coding-uv-ips</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>"
  },
  "url" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips",
  "version" : "0.2.0",
  "name" : "CodeableConcept-uv-ips",
  "title" : "Codeable Concept (IPS)",
  "status" : "draft",
  "date" : "2018-03-19T11:26:15.349+01:00",
  "publisher" : "HL7 International",
  "description" : "This profile leverages the profile of coding-uv-ips for the coding element.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "fhirVersion" : "3.5.0",
  "mapping" : [
    {
      "identity" : "v2",
      "uri" : "http://hl7.org/v2",
      "name" : "HL7 v2 Mapping"
    },
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    },
    {
      "identity" : "orim",
      "uri" : "http://hl7.org/orim",
      "name" : "Ontological RIM Mapping"
    }
  ],
  "kind" : "complex-type",
  "abstract" : false,
  "type" : "CodeableConcept",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/CodeableConcept",
  "derivation" : "constraint",
  "snapshot" : {
    "element" : [
      {
        "id" : "CodeableConcept",
        "path" : "CodeableConcept",
        "short" : "Concept - reference to a terminology or just  text",
        "definition" : "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
        "comment" : "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.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "CodeableConcept",
          "min" : 0,
          "max" : "*"
        },
        "condition" : [
          "ele-1"
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "Element"
          }
        ],
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          },
          {
            "identity" : "v2",
            "map" : "CE/CNE/CWE"
          },
          {
            "identity" : "rim",
            "map" : "CD"
          },
          {
            "identity" : "orim",
            "map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
          }
        ]
      },
      {
        "id" : "CodeableConcept.id",
        "path" : "CodeableConcept.id",
        "representation" : [
          "xmlAttr"
        ],
        "short" : "xml:id (or equivalent in JSON)",
        "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Element.id",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "isModifier" : false,
        "isSummary" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "CodeableConcept.extension",
        "path" : "CodeableConcept.extension",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "url"
            }
          ],
          "description" : "Extensions are always sliced by (at least) url",
          "rules" : "open"
        },
        "short" : "Additional content defined by implementations",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment" : "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" : [
          "extensions",
          "user content"
        ],
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Element.extension",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Extension"
          }
        ],
        "isModifier" : false,
        "isSummary" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "CodeableConcept.coding",
        "path" : "CodeableConcept.coding",
        "short" : "Code defined by a terminology system",
        "definition" : "A reference to a code defined by a terminology system.",
        "comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
        "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "CodeableConcept.coding",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Coding",
            "profile" : [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips"
            ]
          }
        ],
        "isModifier" : false,
        "isSummary" : true,
        "mapping" : [
          {
            "identity" : "v2",
            "map" : "C*E.1-8, C*E.10-22"
          },
          {
            "identity" : "rim",
            "map" : "union(., ./translation)"
          },
          {
            "identity" : "orim",
            "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
          }
        ]
      },
      {
        "id" : "CodeableConcept.text",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean" : true
          }
        ],
        "path" : "CodeableConcept.text",
        "short" : "Plain text representation of the concept",
        "definition" : "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.",
        "comment" : "Very often the text is the same as a displayName of one of the codings.",
        "requirements" : "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" : 0,
        "max" : "1",
        "base" : {
          "path" : "CodeableConcept.text",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "isModifier" : false,
        "isSummary" : true,
        "mapping" : [
          {
            "identity" : "v2",
            "map" : "C*E.9. But note many systems use C*E.2 for this"
          },
          {
            "identity" : "rim",
            "map" : "./originalText[mediaType/code="text/plain"]/data"
          },
          {
            "identity" : "orim",
            "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "CodeableConcept.coding",
        "path" : "CodeableConcept.coding",
        "type" : [
          {
            "code" : "Coding",
            "profile" : [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/coding-uv-ips"
            ]
          }
        ]
      }
    ]
  }
}