ConceptMap - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
contacttrueContactDetail Contact details for the publisher
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the concept map
experimentalfalseboolean For testing purposes, not real usage
grouptrueData Type Same source and target systems
identifierfalseIdentifier Additional identifier for the concept map
jurisdictiontrueCodeableConcept Intended jurisdiction for concept map (if applicable)
namefalsestring Name for this concept map (computer friendly)
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this concept map is defined
sourceReferencefalseReference "sourceReference" : { Reference(ValueSet) },
sourceUrifalseuri "sourceUri" : "<uri>",
statusfalsecode draft | active | retired | unknown
targetReferencefalseReference "targetReference" : { Reference(ValueSet) },
targetUrifalseuri "targetUri" : "<uri>",
titlefalsestring Name for this concept map (human friendly)
urlfalseuri Logical URI to reference this concept map (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the concept map

ConceptMap Example

{
  "status": "draft",
  "publisher": "HL7, Inc",
  "sourceUri": "http://hl7.org/fhir/ValueSet/address-use",
  "name": "FHIR-v3-Address-Use",
  "copyright": "Creative Commons 0",
  "title": "FHIR/v3 Address Use Mapping",
  "resourceType": "ConceptMap",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <h2>FHIR-v3-Address-Use (http://hl7.org/fhir/ConceptMap/101)</h2>\n      <p>Mapping from \n        <a href=\"valueset-address-use.html\">http://hl7.org/fhir/ValueSet/address-use</a> to \n        <a href=\"v3/AddressUse/vs.html\">http://hl7.org/fhir/ValueSet/v3-AddressUse</a>\n      </p>\n      <p>DRAFT (not intended for production usage). Published on 13/06/2012 by HL7, Inc (FHIR project team (example): \n        <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a>). Creative Commons 0\n      </p>\n      <div>\n        <p>A mapping between the FHIR and HL7 v3 AddressUse Code systems</p>\n\n      </div>\n      <br/>\n      <table class=\"grid\">\n        <tr>\n          <td>\n            <b>Source Code</b>\n          </td>\n          <td>\n            <b>Equivalence</b>\n          </td>\n          <td>\n            <b>Destination Code</b>\n          </td>\n          <td>\n            <b>Comment</b>\n          </td>\n        </tr>\n        <tr>\n          <td>home (Home)</td>\n          <td/>\n          <td>H (home address)</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>work (Work)</td>\n          <td/>\n          <td>WP (work place)</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>temp (Temporary)</td>\n          <td/>\n          <td>TMP (temporary address)</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>old (Old / Incorrect)</td>\n          <td>disjoint</td>\n          <td>BAD (bad address)</td>\n          <td>In the HL7 v3 AD, old is handled by the usablePeriod element, but you have to provide a time, there's no simple equivalent of flagging an address as old</td>\n        </tr>\n      </table>\n    </div>"
  },
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ],
      "name": "FHIR project team (example)"
    }
  ],
  "url": "http://hl7.org/fhir/ConceptMap/101",
  "targetUri": "http://hl7.org/fhir/ValueSet/v3-AddressUse",
  "version": "20120613",
  "useContext": [
    {
      "valueCodeableConcept": {
        "text": "for CDA Usage"
      },
      "code": {
        "code": "venue",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    }
  ],
  "purpose": "To help implementers map from HL7 v3/CDA to FHIR",
  "date": "2012-06-13",
  "group": [
    {
      "unmapped": {
        "code": "temp",
        "mode": "fixed",
        "display": "temp"
      },
      "source": "http://hl7.org/fhir/address-use",
      "target": "http://hl7.org/fhir/v3/AddressUse",
      "element": [
        {
          "code": "home",
          "display": "home",
          "target": [
            {
              "code": "H",
              "display": "home"
            }
          ]
        },
        {
          "code": "work",
          "display": "work",
          "target": [
            {
              "code": "WP",
              "display": "work place"
            }
          ]
        },
        {
          "code": "temp",
          "display": "temp",
          "target": [
            {
              "code": "TMP",
              "display": "temporary address"
            }
          ]
        },
        {
          "code": "old",
          "display": "old",
          "target": [
            {
              "comment": "In the HL7 v3 AD, old is handled by the usablePeriod element, but you have to provide a time, there's no simple equivalent of flagging an address as old",
              "equivalence": "disjoint",
              "code": "BAD",
              "display": "bad address"
            }
          ]
        }
      ]
    }
  ],
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:uuid:53cd62ee-033e-414c-9f58-3ca97b5ffc3b"
  },
  "id": "101",
  "experimental": true,
  "description": "A mapping between the FHIR and HL7 v3 AddressUse Code systems"
}

ConceptMap Structure


  
{
  "resourceType" : "ConceptMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this concept map (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the concept map
  "version" : "<string>", // Business version of the concept map
  "name" : "<string>", // Name for this concept map (computer friendly)
  "title" : "<string>", // Name for this concept map (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable)
  "purpose" : "<markdown>", // Why this concept map is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  // source[x]: Identifies the source of the concepts which are being mapped. One of these 2:
  "sourceUri" : "<uri>",
  "sourceReference" : { Reference(ValueSet) },
  // target[x]: Provides context to the mappings. One of these 2:
  "targetUri" : "<uri>",
  "targetReference" : { Reference(ValueSet) },
  "group" : [{ // Same source and target systems
    "source" : "<uri>", // Code System (if value set crosses code systems)
    "sourceVersion" : "<string>", // Specific version of the  code system
    "target" : "<uri>", // System of the target (if necessary)
    "targetVersion" : "<string>", // Specific version of the  code system
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // Identifies element being mapped
      "display" : "<string>", // Display for the code
      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "display" : "<string>", // Display for the code
        "equivalence" : "<code>", // relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        "comment" : "<string>", // C? Description of status/issues in mapping
        "dependsOn" : [{ // Other elements required for this mapping (from context)
          "property" : "<uri>", // R!  Reference to property mapping depends on
          "system" : "<uri>", // Code System (if necessary)
          "code" : "<string>", // R!  Value of the referenced element
          "display" : "<string>" // Display for the code
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
      }]
    }],
    "unmapped" : { // When no match in the mappings
      "mode" : "<code>", // R!  provided | fixed | other-map
      "code" : "<code>", // Fixed code when mode = fixed
      "display" : "<string>", // Display for the code
      "url" : "<uri>" // Canonical URL for other concept map
    }
  }]
}


 

ConceptMap Search Parameters

The following search parameters can be used to query ConceptMap resources. Just submit the like so:

https://api.1up.health/fhir/stu3/ConceptMap?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
datedatedate
dependsonurigroup.element.target.dependsOn.property
descriptiontextdescription
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
otherurigroup.unmapped.url
producturigroup.element.target.product.property
publishertextpublisher
sourcereferencesource.as
source-codetextgroup.element.code
source-systemurigroup.source
source-urireferencesource.as
statustextstatus
targetreferencetarget.as
target-codetextgroup.element.target.code
target-systemurigroup.target
target-urireferencetarget.as
titletexttitle
urluriurl
versiontextversion