NamingSystem - FHIR Resource (r4)
This NamingSystem Resource uses the FHIR API standard for access and structure.
Validate an NamingSystem FHIR Resource (r4)
NamingSystem Attributes
AttributeField is listTypeDescription
Description: C? Name for this naming system (computer friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "SNOMED CT"Learn more about the (NamingSystem) name FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (NamingSystem) status FHIR attribute
Description: codesystem | identifier | root
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"kind": "codesystem"Learn more about the (NamingSystem) kind FHIR attribute
Description: Date last changed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2014-12-13"Learn more about the (NamingSystem) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "HL7 International on behalf of IHTSDO"Learn more about the (NamingSystem) publisher FHIR attribute
Description: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"name": "FHIR project team",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
]Learn more about the (NamingSystem) contact FHIR attribute
Description: Who maintains system namespace?
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"responsible": "IHTSDO & affiliates"Learn more about the (NamingSystem) responsible FHIR attribute
Description: e.g. driver, provider, patient, bank etc.
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (NamingSystem) type FHIR attribute
Description: Natural language description of the naming system
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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."Learn more about the (NamingSystem) description FHIR attribute
Description: The context that the content is intended to support
FHIR Version: r4
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (NamingSystem) useContext FHIR attribute
Description: Intended jurisdiction for naming system (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": Learn more about the (NamingSystem) jurisdiction FHIR attribute
Description: How/where is it used
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"usage": Learn more about the (NamingSystem) usage FHIR attribute
Description: Unique identifiers used for system
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"uniqueId": [
{
"type": "oid",
"value": "2.16.840.1.113883.6.96"
},
{
"type": "uri",
"value": "http://snomed.info/sct",
"preferred": true
}
]Learn more about the (NamingSystem) uniqueId FHIR attribute
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
contact | text | contact.name |
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
description | text | description |
id-type | text | uniqueId.type |
jurisdiction | text | jurisdiction |
kind | text | kind |
name | text | name |
period | date | uniqueId.period |
publisher | text | publisher |
responsible | text | responsible |
status | text | status |
telecom | text | contact.telecom |
type | text | type |
value | text | uniqueId.value |
