FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example NamingSystem/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 Naming System Metadata

{
  "resourceType" : "NamingSystem",
  "id" : "example-metadata",
  "meta" : {
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablenamingsystem"]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: NamingSystem</b><a name=\"example-metadata\"> </a><a name=\"hcexample-metadata\"> </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&quot; </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"shareablenamingsystem.html\">Shareable NamingSystem</a></p></div><p><b>StructureDefinition Work Group</b>: vocab</p><p><b>url</b>: <code>http://hl7.org/fhir/NamingSystem/example-metadata</code></p><p><b>identifier</b>: <a href=\"http://terminology.hl7.org/5.5.0/NamingSystem-uri.html\" title=\"As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt \r\n\r\nThis oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid: \r\n\r\nNote that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.\r\n\r\nThis OID may also be used in CD.codeSystem.\">URI</a>/urn:oid:2.16.840.1.113883.4.642.22.5</p><p><b>version</b>: 20210721</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>: 2021-07-21</p><p><b>publisher</b>: HL7 International / Terminology Infrastructure</p><p><b>contact</b>: FHIR project team: <a href=\"http://www.hl7.org/Special/committees/Vocab\">http://www.hl7.org/Special/committees/Vocab</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>: 2021-08-01 --&gt; 2022-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.5.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 style=\"display: none\">-</td><td><b>Type</b></td><td><b>Resource</b></td></tr><tr><td style=\"display: none\">*</td><td>derived-from</td><td><a href=\"http://hl7.org/fhir/NamingSystem/example\">http://hl7.org/fhir/NamingSystem/example</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>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"
  }],
  "url" : "http://hl7.org/fhir/NamingSystem/example-metadata",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.22.5"
  }],
  "version" : "20210721",
  "name" : "ExampleMetadata",
  "title" : "Metadata Example",
  "status" : "draft",
  "kind" : "identifier",
  "experimental" : true,
  "date" : "2021-07-21",
  "publisher" : "HL7 International / Terminology Infrastructure",
  "contact" : [{
    "name" : "FHIR project team",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/Vocab"
    }]
  }],
  "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" : "2021-08-01",
    "end" : "2022-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"
  }],
  "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.