Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example ConceptMap/example-metadata-2 (Turtle)

Vocabulary Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw Turtle (+ also see Turtle/RDF Format Specification)

Example Concept Map Metadata v2

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:ConceptMap;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example-metadata-2"];
  fhir:Resource.meta [
     fhir:Meta.profile [
       fhir:value "http://hl7.org/fhir/StructureDefinition/shareableconceptmap";
       fhir:index 0;
       fhir:link <http://hl7.org/fhir/StructureDefinition/shareableconceptmap>
     ]
  ];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ];
     fhir:Narrative.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>"
  ];
  fhir:ConceptMap.url [ fhir:value "http://hl7.org/fhir/ConceptMap/example-metadata-2"];
  fhir:ConceptMap.identifier [
     fhir:index 0;
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.14.4" ]
  ];
  fhir:ConceptMap.version [ fhir:value "5.0.0-ballot"];
  fhir:ConceptMap.name [ fhir:value "ExampleMetadata"];
  fhir:ConceptMap.title [ fhir:value "Metadata Example"];
  fhir:ConceptMap.status [ fhir:value "draft"];
  fhir:ConceptMap.experimental [ fhir:value "true"^^xsd:boolean];
  fhir:ConceptMap.date [ fhir:value "2022-07-21"^^xsd:date];
  fhir:ConceptMap.publisher [ fhir:value "FHIR (Example)"];
  fhir:ConceptMap.contact [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "FHIR project team" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ]
  ];
  fhir:ConceptMap.description [ fhir:value "This is an example concept map that illustrates usage of the metadata resource elements introduced in R5"];
  fhir:ConceptMap.approvalDate [ fhir:value "2021-07-21"^^xsd:date];
  fhir:ConceptMap.lastReviewDate [ fhir:value "2022-07-21"^^xsd:date];
  fhir:ConceptMap.effectivePeriod [
     fhir:Period.start [ fhir:value "2022-08-01"^^xsd:date ];
     fhir:Period.end [ fhir:value "2023-07-31"^^xsd:date ]
  ];
  fhir:ConceptMap.topic [
     fhir:index 0;
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/definition-topic" ];
       fhir:Coding.code [ fhir:value "treatment" ];
       fhir:Coding.display [ fhir:value "Treatment" ]
     ]
  ];
  fhir:ConceptMap.author [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "ACME ConceptMap Development" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://acme.org/development" ]
     ]
  ];
  fhir:ConceptMap.editor [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "ACME ConceptMap Management" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://acme.org/management" ]
     ]
  ];
  fhir:ConceptMap.reviewer [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "Society for Creative ConceptMap Review" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://example.org/sccr" ]
     ]
  ];
  fhir:ConceptMap.endorser [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "National Foundation for ConceptMap Quality" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://example.org/nfcq" ]
     ]
  ];
  fhir:ConceptMap.relatedArtifact [
     fhir:index 0;
     fhir:RelatedArtifact.type [ fhir:value "derived-from" ];
     fhir:RelatedArtifact.resource [
       fhir:value "http://hl7.org/fhir/ConceptMap/example";
       fhir:link <http://hl7.org/fhir/ConceptMap/example>
     ]
  ], [
     fhir:index 1;
     fhir:RelatedArtifact.type [ fhir:value "predecessor" ];
     fhir:RelatedArtifact.resource [
       fhir:value "http://hl7.org/fhir/ConceptMap/example-metadata|20210701";
       fhir:link <http://hl7.org/fhir/ConceptMap/example-metadata|20210701>
     ]
  ];
  fhir:ConceptMap.sourceScopeUri [ fhir:value "http://hl7.org/fhir/ValueSet/address-use"];
  fhir:ConceptMap.targetScopeUri [ fhir:value "http://terminology.hl7.org/ValueSet/v3-AddressUse"];
  fhir:ConceptMap.group [
     fhir:index 0;
     fhir:ConceptMap.group.source [
       fhir:value "http://hl7.org/fhir/address-use";
       fhir:link <http://hl7.org/fhir/address-use>
     ];
     fhir:ConceptMap.group.target [
       fhir:value "http://terminology.hl7.org/CodeSystem/v3-AddressUse";
       fhir:link <http://terminology.hl7.org/CodeSystem/v3-AddressUse>
     ];
     fhir:ConceptMap.group.element [
       fhir:index 0;
       fhir:ConceptMap.group.element.code [ fhir:value "home" ];
       fhir:ConceptMap.group.element.display [ fhir:value "home" ];
       fhir:ConceptMap.group.element.target [
         fhir:index 0;
         fhir:ConceptMap.group.element.target.code [ fhir:value "H" ];
         fhir:ConceptMap.group.element.target.display [ fhir:value "home" ];
         fhir:ConceptMap.group.element.target.relationship [ fhir:value "equivalent" ]
       ]
     ], [
       fhir:index 1;
       fhir:ConceptMap.group.element.code [ fhir:value "work" ];
       fhir:ConceptMap.group.element.display [ fhir:value "work" ];
       fhir:ConceptMap.group.element.target [
         fhir:index 0;
         fhir:ConceptMap.group.element.target.code [ fhir:value "WP" ];
         fhir:ConceptMap.group.element.target.display [ fhir:value "work place" ];
         fhir:ConceptMap.group.element.target.relationship [ fhir:value "equivalent" ]
       ]
     ], [
       fhir:index 2;
       fhir:ConceptMap.group.element.code [ fhir:value "temp" ];
       fhir:ConceptMap.group.element.display [ fhir:value "temp" ];
       fhir:ConceptMap.group.element.target [
         fhir:index 0;
         fhir:ConceptMap.group.element.target.code [ fhir:value "TMP" ];
         fhir:ConceptMap.group.element.target.display [ fhir:value "temporary address" ];
         fhir:ConceptMap.group.element.target.relationship [ fhir:value "equivalent" ]
       ]
     ], [
       fhir:index 3;
       fhir:ConceptMap.group.element.code [ fhir:value "old" ];
       fhir:ConceptMap.group.element.display [ fhir:value "old" ];
       fhir:ConceptMap.group.element.target [
         fhir:index 0;
         fhir:ConceptMap.group.element.target.code [ fhir:value "BAD" ];
         fhir:ConceptMap.group.element.target.display [ fhir:value "bad address" ];
         fhir:ConceptMap.group.element.target.relationship [ fhir:value "not-related-to" ];
         fhir:ConceptMap.group.element.target.comment [ fhir:value "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" ]
       ]
     ];
     fhir:ConceptMap.group.unmapped [
       fhir:ConceptMap.group.unmapped.mode [ fhir:value "fixed" ];
       fhir:ConceptMap.group.unmapped.code [ fhir:value "temp" ];
       fhir:ConceptMap.group.unmapped.display [ fhir:value "temp" ];
       fhir:ConceptMap.group.unmapped.relationship [ fhir:value "related-to" ]
     ]
  ]] .

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------


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.