Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Example CodeSystem/example-metadata (JSON)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

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

Example Code System Metadata

{
  "resourceType" : "CodeSystem",
  "id" : "example-metadata",
  "meta" : {
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>This code system \n        <code>http://hl7.org/fhir/CodeSystem/example-metadata</code> defines the following codes:\n      </p>\n      <table class=\"codes\">\n        <tr>\n          <td style=\"white-space:nowrap\">\n            <b>Code</b>\n          </td>\n          <td>\n            <b>Definition</b>\n          </td>\n        </tr>\n        <tr>\n          <td style=\"white-space:nowrap\">A\n            <a name=\"example-metadata-A\"> </a>\n          </td>\n          <td>A</td>\n        </tr>\n        <tr>\n          <td style=\"white-space:nowrap\">B\n            <a name=\"example-metadata-B\"> </a>\n          </td>\n          <td>B</td>\n        </tr>\n        <tr>\n          <td style=\"white-space:nowrap\">C\n            <a name=\"example-metadata-C\"> </a>\n          </td>\n          <td>C</td>\n        </tr>\n      </table>\n    </div>"
  },
  "url" : "http://hl7.org/fhir/CodeSystem/example-metadata",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.1824"
  }],
  "version" : "5.0.0",
  "name" : "ExampleMetadata",
  "title" : "Metadata Example",
  "status" : "draft",
  "experimental" : true,
  "date" : "2021-07-21",
  "publisher" : "FHIR (Example)",
  "contact" : [{
    "name" : "FHIR project team",
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "This is an example code system that illustrates usage of the metadata resource elements introduced in R5",
  "approvalDate" : "2021-07-21",
  "lastReviewDate" : "2022-07-21",
  "effectivePeriod" : {
    "start" : "2021-08-01",
    "end" : "2022-07-31"
  },
  "topic" : [{
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/definition-topic",
      "code" : "treatment",
      "display" : "Treatment"
    }]
  }],
  "author" : [{
    "name" : "ACME CodeSystem Development",
    "telecom" : [{
      "system" : "url",
      "value" : "http://acme.org/development"
    }]
  }],
  "editor" : [{
    "name" : "ACME CodeSystem Management",
    "telecom" : [{
      "system" : "url",
      "value" : "http://acme.org/management"
    }]
  }],
  "reviewer" : [{
    "name" : "Society for Creative CodeSystem Review",
    "telecom" : [{
      "system" : "url",
      "value" : "http://example.org/sccr"
    }]
  }],
  "endorser" : [{
    "name" : "National Foundation for CodeSystem Quality",
    "telecom" : [{
      "system" : "url",
      "value" : "http://example.org/nfcq"
    }]
  }],
  "relatedArtifact" : [{
    "type" : "derived-from",
    "resource" : "http://hl7.org/fhir/CodeSystem/example"
  }],
  "caseSensitive" : true,
  "content" : "complete",
  "concept" : [{
    "code" : "A",
    "display" : "A",
    "definition" : "A"
  },
  {
    "code" : "B",
    "display" : "B",
    "definition" : "B"
  },
  {
    "code" : "C",
    "display" : "C",
    "definition" : "C"
  }]
}

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.