C-CDA on FHIR
2.0.0-ballot - STU 2 Ballot United States of America flag

C-CDA on FHIR, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ccda-on-fhir/ and changes regularly. See the Directory of published versions

: FHIR to C-CDA NameUse - JSON Representation

Active as of 2024-12-17

Raw json | Download

{
  "resourceType" : "ConceptMap",
  "id" : "FC-NameUse",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ConceptMap FC-NameUse</b></p><a name=\"FC-NameUse\"> </a><a name=\"hcFC-NameUse\"> </a><a name=\"FC-NameUse-en-US\"> </a><p>Mapping from <a href=\"http://hl7.org/fhir/R4/valueset-name-use.html\">NameUse</a> to https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.1.11.15913</p><br/><p><b>Group 1 </b>Mapping from <a href=\"http://hl7.org/fhir/R4/codesystem-name-use.html\">NameUse</a> to <a href=\"http://terminology.hl7.org/6.1.0/CodeSystem-v3-EntityNameUse.html\">EntityNameUse</a></p><table class=\"grid\"><tr><td colspan=\"2\"><b>Source Concept Details</b></td><td><b>Relationship</b></td><td colspan=\"2\"><b>Target Concept Details</b></td><td><b>Comment</b></td><td colspan=\"2\"><b>Properties</b></td></tr><tr><td colspan=\"2\"><b>Codes</b> from <a href=\"http://hl7.org/fhir/R4/codesystem-name-use.html\" title=\"http://hl7.org/fhir/name-use\">NameUse</a></td><td/><td colspan=\"2\"><b>Codes</b> from <a href=\"http://terminology.hl7.org/6.1.0/CodeSystem-v3-EntityNameUse.html\" title=\"http://terminology.hl7.org/CodeSystem/v3-EntityNameUse\">EntityNameUse</a></td><td/></tr><tr><td style=\"border-right-width: 0px\">usual</td><td style=\"border-left-width: 0px\">Usual</td><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equal\" title=\"equal\">is equal to</a></td><td style=\"border-right-width: 0px\">L</td><td style=\"border-left-width: 0px\">Legal</td><td>Known as/conventional/the one you normally use</td></tr><tr><td style=\"border-right-width: 0px; border-bottom-style: none\">official</td><td style=\"border-left-width: 0px; border-bottom-style: none\">Official</td><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">C</td><td style=\"border-left-width: 0px\">License</td><td>If another name exists with use=usual, then the official name is equivalent to a license</td></tr><tr><td style=\"border-right-width: 0px; border-top-style: none\"/><td style=\"border-top-style: none; border-left-width: 0px\"/><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">L</td><td style=\"border-left-width: 0px\">Legal</td><td>If no other name exist, official may be called &quot;legal name&quot;</td></tr><tr><td style=\"border-right-width: 0px; border-bottom-style: none\">temp</td><td style=\"border-left-width: 0px\">Temp</td><td colspan=\"4\" style=\"background-color: #efefef\">(not mapped)</td></tr><tr><td style=\"border-right-width: 0px\">nickname</td><td style=\"border-left-width: 0px\">Nickname</td><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#inexact\" title=\"inexact\">maps loosely to</a></td><td style=\"border-right-width: 0px\">P</td><td style=\"border-left-width: 0px\">pseudonym</td><td>In CDA, nicknames are identified by a use code of P and qualifiers on name parts of CL (callme)</td></tr><tr><td style=\"border-right-width: 0px\">anonymous</td><td style=\"border-left-width: 0px\">Anonymous</td><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/CodeSystem-concept-map-equivalence.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td style=\"border-right-width: 0px\">P</td><td style=\"border-left-width: 0px\">pseudonym</td><td/></tr><tr><td style=\"border-right-width: 0px; border-bottom-style: none\">old</td><td style=\"border-left-width: 0px\">Old</td><td colspan=\"4\" style=\"background-color: #efefef\">(not mapped)</td></tr><tr><td style=\"border-right-width: 0px; border-bottom-style: none\">maiden</td><td style=\"border-left-width: 0px\">Name changed for Marriage</td><td colspan=\"4\" style=\"background-color: #efefef\">(not mapped)</td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cgp"
    }
  ],
  "url" : "http://hl7.org/fhir/us/ccda/ConceptMap/FC-NameUse",
  "version" : "2.0.0-ballot",
  "name" : "FHIRtoCCDANameUse",
  "title" : "FHIR to C-CDA NameUse",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-12-17T19:55:43+00:00",
  "publisher" : "HL7 International / Cross-Group Projects",
  "contact" : [
    {
      "name" : "HL7 International / Cross-Group Projects",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        }
      ]
    }
  ],
  "description" : "FHIR to C-CDA NameUse. Based on http://hl7.org/fhir/cm-name-use-v3.html",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "sourceUri" : "http://hl7.org/fhir/ValueSet/name-use",
  "targetUri" : "https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.1.11.15913",
  "group" : [
    {
      "source" : "http://hl7.org/fhir/name-use",
      "target" : "http://terminology.hl7.org/CodeSystem/v3-EntityNameUse",
      "element" : [
        {
          "code" : "usual",
          "display" : "Usual",
          "target" : [
            {
              "code" : "L",
              "display" : "Legal",
              "equivalence" : "equal",
              "comment" : "Known as/conventional/the one you normally use"
            }
          ]
        },
        {
          "code" : "official",
          "display" : "Official",
          "target" : [
            {
              "code" : "C",
              "display" : "License",
              "equivalence" : "equivalent",
              "comment" : "If another name exists with use=usual, then the official name is equivalent to a license"
            },
            {
              "code" : "L",
              "display" : "Legal",
              "equivalence" : "equivalent",
              "comment" : "If no other name exist, official may be called \"legal name\""
            }
          ]
        },
        {
          "code" : "temp",
          "display" : "Temp",
          "target" : [
            {
              "equivalence" : "unmatched"
            }
          ]
        },
        {
          "code" : "nickname",
          "display" : "Nickname",
          "target" : [
            {
              "code" : "P",
              "display" : "pseudonym",
              "equivalence" : "inexact",
              "comment" : "In CDA, nicknames are identified by a use code of P and qualifiers on name parts of CL (callme)"
            }
          ]
        },
        {
          "code" : "anonymous",
          "display" : "Anonymous",
          "target" : [
            {
              "code" : "P",
              "display" : "pseudonym",
              "equivalence" : "equivalent"
            }
          ]
        },
        {
          "code" : "old",
          "display" : "Old",
          "target" : [
            {
              "equivalence" : "unmatched"
            }
          ]
        },
        {
          "code" : "maiden",
          "display" : "Name changed for Marriage",
          "target" : [
            {
              "equivalence" : "unmatched"
            }
          ]
        }
      ]
    }
  ]
}