Release 5 Ballot

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

Example CodeSystem/example-metadata-2 (JSON)

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

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

Example Code System Metadata v2

{
  "resourceType": "CodeSystem",
  "id": "example-metadata-2",
  "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-2</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>Display</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-2-A\"> </a>\n          </td>\n          <td>A</td>\n          <td>A</td>\n        </tr>\n        <tr>\n          <td style=\"white-space:nowrap\">B\n            <a name=\"example-metadata-2-B\"> </a>\n          </td>\n          <td>B</td>\n          <td>B</td>\n        </tr>\n        <tr>\n          <td style=\"white-space:nowrap\">C\n            <a name=\"example-metadata-2-C\"> </a>\n          </td>\n          <td>C</td>\n          <td>C</td>\n        </tr>\n        <tr>\n          <td style=\"white-space:nowrap\">D\n            <a name=\"example-metadata-2-D\"> </a>\n          </td>\n          <td>D</td>\n          <td>D</td>\n        </tr>\n      </table>\n    </div>"
  },
  "url": "http://hl7.org/fhir/CodeSystem/example-metadata-2",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.4.1829"
    }
  ],
  "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 code system 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 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"
    },
    {
      "type": "predecessor",
      "resource": "http://hl7.org/fhir/CodeSystem/example-metadata|20210701"
    }
  ],
  "caseSensitive": true,
  "content": "complete",
  "concept": [
    {
      "code": "A",
      "display": "A",
      "definition": "A"
    },
    {
      "code": "B",
      "display": "B",
      "definition": "B"
    },
    {
      "code": "C",
      "display": "C",
      "definition": "C"
    },
    {
      "code": "D",
      "display": "D",
      "definition": "D"
    }
  ]
}

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.