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 NamingSystem/example-metadata-2 (JSON)

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

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

Example Naming System Metadata v2

{
  "resourceType" : "NamingSystem",
  "id" : "example-metadata-2",
  "meta" : {
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablenamingsystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: NamingSystem</b><a name=\"example-metadata-2\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource NamingSystem &quot;example-metadata-2&quot; </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"shareablenamingsystem.html\">Shareable NamingSystem</a></p></div><p><b>url</b>: <code>http://hl7.org/fhir/NamingSystem/example-metadata-2</code></p><p><b>identifier</b>: id:\u00a0urn:oid:2.16.840.1.113883.4.642.22.4</p><p><b>version</b>: 20220721</p><p><b>name</b>: ExampleMetadata</p><p><b>title</b>: Metadata Example</p><p><b>status</b>: draft</p><p><b>kind</b>: identifier</p><p><b>experimental</b>: true</p><p><b>date</b>: 2022-07-21</p><p><b>publisher</b>: FHIR (Example)</p><p><b>contact</b>: FHIR project team: <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a></p><p><b>description</b>: This is an example naming system that illustrates usage of the metadata resource elements introduced in R5</p><p><b>approvalDate</b>: 2021-07-21</p><p><b>lastReviewDate</b>: 2022-07-21</p><p><b>effectivePeriod</b>: 2022-08-01 --&gt; 2023-07-31</p><p><b>topic</b>: Treatment <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-definition-topic.html\">DefinitionTopic</a>#treatment)</span></p><p><b>author</b>: ACME NamingSystem Development: <a href=\"http://acme.org/development\">http://acme.org/development</a></p><p><b>editor</b>: ACME NamingSystem Management: <a href=\"http://acme.org/management\">http://acme.org/management</a></p><p><b>reviewer</b>: Society for Creative NamingSystem Review: <a href=\"http://example.org/scnr\">http://example.org/scnr</a></p><p><b>endorser</b>: National Foundation for NamingSystem Quality: <a href=\"http://example.org/nfnq\">http://example.org/nfnq</a></p><h3>RelatedArtifacts</h3><table class=\"grid\"><tr><td>-</td><td><b>Type</b></td><td><b>Resource</b></td></tr><tr><td>*</td><td>derived-from</td><td><a href=\"http://hl7.org/fhir/NamingSystem/example\">http://hl7.org/fhir/NamingSystem/example</a></td></tr><tr><td>*</td><td>predecessor</td><td><a href=\"http://hl7.org/fhir/NamingSystem/example-metadata\">http://hl7.org/fhir/NamingSystem/example-metadata|20210701</a></td></tr></table><blockquote><p><b>uniqueId</b></p><p><b>type</b>: oid</p><p><b>value</b>: 1.2.3.4.5.6.7</p></blockquote><blockquote><p><b>uniqueId</b></p><p><b>type</b>: uri</p><p><b>value</b>: http://example.com/identifiers</p><p><b>preferred</b>: true</p></blockquote></div>"
  },
  "url" : "http://hl7.org/fhir/NamingSystem/example-metadata-2",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.22.4"
  }],
  "version" : "20220721",
  "name" : "ExampleMetadata",
  "title" : "Metadata Example",
  "status" : "draft",
  "kind" : "identifier",
  "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 naming 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 NamingSystem Development",
    "telecom" : [{
      "system" : "url",
      "value" : "http://acme.org/development"
    }]
  }],
  "editor" : [{
    "name" : "ACME NamingSystem Management",
    "telecom" : [{
      "system" : "url",
      "value" : "http://acme.org/management"
    }]
  }],
  "reviewer" : [{
    "name" : "Society for Creative NamingSystem Review",
    "telecom" : [{
      "system" : "url",
      "value" : "http://example.org/scnr"
    }]
  }],
  "endorser" : [{
    "name" : "National Foundation for NamingSystem Quality",
    "telecom" : [{
      "system" : "url",
      "value" : "http://example.org/nfnq"
    }]
  }],
  "relatedArtifact" : [{
    "type" : "derived-from",
    "resource" : "http://hl7.org/fhir/NamingSystem/example"
  },
  {
    "type" : "predecessor",
    "resource" : "http://hl7.org/fhir/NamingSystem/example-metadata|20210701"
  }],
  "uniqueId" : [{
    "type" : "oid",
    "value" : "1.2.3.4.5.6.7"
  },
  {
    "type" : "uri",
    "value" : "http://example.com/identifiers",
    "preferred" : true
  }]
}

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.