FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Conceptmap-example.json

Example ConceptMap/101 (JSON)

Maturity Level : N/A
Responsible Owner: Vocabulary Terminology Infrastructure Work Group Ballot Standards Status : Informative Compartments : Not linked to any No defined compartments

Raw JSON ( canonical form + also see JSON Format Specification )

General ConceptMap Example 

{
  "resourceType": "ConceptMap",
  "id": "101",
  "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>"

  "resourceType" : "ConceptMap",
  "id" : "101",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p class=\"res-header-id\">\n        <b>Generated Narrative: ConceptMap 101</b>\n      </p>\n      <a name=\"101\"> </a>\n      <a name=\"hc101\"> </a>\n      <p>Mapping from \n        <a href=\"valueset-address-use.html\">AddressUse</a> to \n        <a href=\"http://terminology.hl7.org/6.5.0/ValueSet-v3-AddressUse.html\">AddressUse</a>\n      </p>\n      <br/>\n      <p>\n        <b>Group 1 </b>Mapping from \n        <a href=\"codesystem-address-use.html\">AddressUse</a> to \n        <a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-AddressUse.html\">AddressUse</a>\n      </p>\n      <table class=\"grid\">\n        <tr>\n          <td>\n            <b>Source Code</b>\n          </td>\n          <td>\n            <b>Relationship</b>\n          </td>\n          <td>\n            <b>Target Code</b>\n          </td>\n          <td>\n            <b>Comment</b>\n          </td>\n        </tr>\n        <tr>\n          <td>home</td>\n          <td>\n            <a href=\"codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a>\n          </td>\n          <td>H (home address)</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>work</td>\n          <td>\n            <a href=\"codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a>\n          </td>\n          <td>WP (work place)</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>temp (Temporary)</td>\n          <td>\n            <a href=\"codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a>\n          </td>\n          <td>TMP (temporary address)</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>old (Old / Incorrect)</td>\n          <td>\n            <a href=\"codesystem-concept-map-relationship.html#not-related-to\" title=\"not-related-to\">is not related to</a>\n          </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>"

  },
  "url": "http://hl7.org/fhir/ConceptMap/101",
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:uuid:53cd62ee-033e-414c-9f58-3ca97b5ffc3b"

  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"
  }],
  "url" : "http://hl7.org/fhir/ConceptMap/101",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.14.1"

  },
  "version": "20120613",
  "name": "FHIR-v3-Address-Use",
  "title": "FHIR/v3 Address Use Mapping",
  "status": "draft",
  "experimental": true,
  "date": "2012-06-13",
  "publisher": "HL7, Inc",
  "contact": [
    {
      "name": "FHIR project team (example)",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]

  {
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:uuid:53cd62ee-033e-414c-9f58-3ca97b5ffc3b"
  }],
  "version" : "6.0.0-ballot3",
  "name" : "FHIRv3AddressUse",
  "title" : "FHIR/v3 Address Use Mapping",
  "status" : "draft",
  "experimental" : true,
  "date" : "2012-06-13",
  "publisher" : "HL7 International / Terminology Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/Vocab"
    }]
  }],
  "description" : "A mapping between the FHIR and HL7 v3 AddressUse Code systems",
  "useContext" : [{
    "code" : {
      "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code" : "venue"
    },
    "valueCodeableConcept" : {
      "text" : "for CCDA Usage"

    }
  ],
  "description": "A mapping between the FHIR and HL7 v3 AddressUse Code systems",
  "useContext": [

  }],
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "purpose" : "To help implementers map from FHIR to HL7 v3/CDA",
  "copyright" : "Creative Commons 0",
  "sourceScopeUri" : "http://hl7.org/fhir/ValueSet/address-use",
  "targetScopeUri" : "http://terminology.hl7.org/ValueSet/v3-AddressUse",
  "group" : [{
    "source" : "http://hl7.org/fhir/address-use",
    "target" : "http://terminology.hl7.org/CodeSystem/v3-AddressUse",
    "element" : [{
      "code" : "home",
      "display" : "Home",
      "target" : [{
        "code" : "H",
        "display" : "home address",
        "relationship" : "equivalent"
      }]
    },

    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",
        "code": "venue"
      },
      "valueCodeableConcept": {
        "text": "for CDA Usage"
      }
    }
  ],
  "purpose": "To help implementers map from HL7 v3/CDA to FHIR",
  "copyright": "Creative Commons 0",
  "sourceUri": "http://hl7.org/fhir/ValueSet/address-use",
  "targetUri": "http://hl7.org/fhir/ValueSet/v3-AddressUse",
  "group": [

      "code" : "work",
      "display" : "Work",
      "target" : [{
        "code" : "WP",
        "display" : "work place",
        "relationship" : "equivalent"
      }]
    },

    {
      "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": [
            {
              "code": "BAD",
              "display": "bad address",
              "equivalence": "disjoint",
              "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"
            }
          ]
        }
      ],
      "unmapped": {
        "mode": "fixed",
        "code": "temp",
        "display": "temp"
      }

      "code" : "temp",
      "display" : "Temporary",
      "target" : [{
        "code" : "TMP",
        "display" : "temporary address",
        "relationship" : "equivalent"
      }]
    },
    {
      "code" : "old",
      "display" : "Old / Incorrect",
      "target" : [{
        "code" : "BAD",
        "display" : "bad address",
        "relationship" : "not-related-to",
        "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"
      }]
    }],
    "unmapped" : {
      "mode" : "fixed",
      "code" : "temp",
      "display" : "temp",
      "relationship" : "related-to"

    }
  ]

  }]

}

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.