NamingSystem - FHIR Resource (r4)


This NamingSystem Resource uses the FHIR API standard for access and structure.

Validate an NamingSystem FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
contacttrueContactDetail# Contact details for the publisher
datefalsedateTime# Date last changed
descriptionfalsemarkdown# Natural language description of the naming system
jurisdictiontrueCodeableConcept# Intended jurisdiction for naming system (if applicable)
kindfalsecode# codesystem | identifier | root
namefalsestring# C? Name for this naming system (computer friendly)
publisherfalsestring# Name of the publisher (organization or individual)
responsiblefalsestring# Who maintains system namespace?
statusfalsecode# draft | active | retired | unknown
typefalseCodeableConcept# e.g. driver, provider, patient, bank etc.
uniqueIdtrueData Type# Unique identifiers used for system
usagefalsestring# How/where is it used
useContexttrueUsageContext# The context that the content is intended to support

NamingSystem Example

{
  "resourceType": "NamingSystem",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      \n      <p>\n        <b>SNOMED CT</b>\n      </p>\n      \n      <p> oid: 2.16.840.1.113883.6.96</p>\n      \n      <p> uri: http://snomed.info/sct</p>\n    \n    </div>"
  },
  "name": "SNOMED CT",
  "status": "active",
  "kind": "codesystem",
  "date": "2014-12-13",
  "publisher": "HL7 International on behalf of IHTSDO",
  "contact": [
    {
      "name": "FHIR project team",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "responsible": "IHTSDO & affiliates",
  "description": "SNOMED CT is a concept-based, scientifically validated terminology that provides a unique and permanent concept identifier that can be included in multiple HL7 data types including CD and CE.  The concepts are managed to avoid \"semantic drift\" so the meaning remains constant.  If the concept is found to be ambiguous or the meaning changes, the concept is inactivated but still retained and the identifier is never reused.    SNOMED CT's concepts are interrelated hierarchically and using description logic.    SNOMED CT concepts have a unique \"fully-specified name\", a preferred term, and, optionally, synonyms.  The description languages include English and Spanish.",
  "uniqueId": [
    {
      "type": "oid",
      "value": "2.16.840.1.113883.6.96"
    },
    {
      "type": "uri",
      "value": "http://snomed.info/sct",
      "preferred": true
    }
  ]
}

NamingSystem Structure

{
  "resourceType" : "NamingSystem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "name" : "<string>", // C? R!  Name for this naming system (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // R!  codesystem | identifier | root
  "date" : "<dateTime>", // R!  Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "responsible" : "<string>", // Who maintains system namespace?
  "type" : { CodeableConcept }, // e.g. driver,  provider,  patient, bank etc.
  "description" : "<markdown>", // Natural language description of the naming system
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for naming system (if applicable)
  "usage" : "<string>", // How/where is it used
  "uniqueId" : [{ // R!  Unique identifiers used for system
    "type" : "<code>", // R!  oid | uuid | uri | other
    "value" : "<string>", // R!  The unique identifier
    "preferred" : <boolean>, // Is this the id that should be used for this type
    "comment" : "<string>", // Notes about identifier usage
    "period" : { Period } // When is identifier valid?
  }]
}

NamingSystem Search Parameters

The following search parameters can be used to query NamingSystem resources. Just submit them like so:

https://api.1up.health/fhir/r4/NamingSystem?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
contacttextcontact.name
contexttextuseContext.value
context-quantityquantityuseContext.value
context-typetextuseContext.code
context-type-quantitycompositeuseContext
context-type-valuecompositeuseContext
datedatedate
descriptiontextdescription
id-typetextuniqueId.type
jurisdictiontextjurisdiction
kindtextkind
nametextname
perioddateuniqueId.period
publishertextpublisher
responsibletextresponsible
statustextstatus
telecomtextcontact.telecom
typetexttype
valuetextuniqueId.value