This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Vocabulary Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
Example Concept Map Metadata v2
{ "resourceType": "ConceptMap", "id": "example-metadata-2", "meta": { "profile": [ "http://hl7.org/fhir/StructureDefinition/shareableconceptmap" ] }, "text": { "status": "extensions", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>ExampleMetadata (http://hl7.org/fhir/ConceptMap/example-metadata-2)</h2>\n <p>Mapping from \n <a href=\"valueset-address-use.html\">http://hl7.org/fhir/ValueSet/address-use</a> to \n <a href=\"http://terminology.hl7.org/3.1.0/ValueSet-v3-AddressUse.html\">http://terminology.hl7.org/ValueSet/v3-AddressUse</a>\n </p>\n <p>DRAFT (not intended for production usage). Published on 2022-07-21 by FHIR (Example) (FHIR project team: \n <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a>). \n </p>\n <div>\n <p>This is an example concept map that illustrates usage of the metadata resource elements introduced in R5</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>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 colspan=\"4\">Mapping from \n <a href=\"codesystem-address-use.html\">AddressUse</a> to \n <a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-AddressUse.html\">AddressUse</a>\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)</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</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</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/example-metadata-2", "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:oid:2.16.840.1.113883.4.642.14.4" } ], "version": "5.0.0-ballot", "name": "ExampleMetadata", "title": "Metadata Example", "status": "draft", "experimental": true, "date": "2022-07-21", "publisher": "FHIR (Example)", "contact": [ { "name": "FHIR project team", "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "This is an example concept map that illustrates usage of the metadata resource elements introduced in R5", "approvalDate": "2021-07-21", "lastReviewDate": "2022-07-21", "effectivePeriod": { "start": "2022-08-01", "end": "2023-07-31" }, "topic": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/definition-topic", "code": "treatment", "display": "Treatment" } ] } ], "author": [ { "name": "ACME ConceptMap Development", "telecom": [ { "system": "url", "value": "http://acme.org/development" } ] } ], "editor": [ { "name": "ACME ConceptMap Management", "telecom": [ { "system": "url", "value": "http://acme.org/management" } ] } ], "reviewer": [ { "name": "Society for Creative ConceptMap Review", "telecom": [ { "system": "url", "value": "http://example.org/sccr" } ] } ], "endorser": [ { "name": "National Foundation for ConceptMap Quality", "telecom": [ { "system": "url", "value": "http://example.org/nfcq" } ] } ], "relatedArtifact": [ { "type": "derived-from", "resource": "http://hl7.org/fhir/ConceptMap/example" }, { "type": "predecessor", "resource": "http://hl7.org/fhir/ConceptMap/example-metadata|20210701" } ], "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", "relationship": "equivalent" } ] }, { "code": "work", "display": "work", "target": [ { "code": "WP", "display": "work place", "relationship": "equivalent" } ] }, { "code": "temp", "display": "temp", "target": [ { "code": "TMP", "display": "temporary address", "relationship": "equivalent" } ] }, { "code": "old", "display": "old", "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.