NamingSystem

ResourceFoundation · TerminologyTrial useMaturity 1

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

17 of 19 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
nameRequiredΣ	1..1	string	Name for this naming system (computer friendly)
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
kindRequiredΣ	1..1	code	codesystem | identifier | rootBinding (required): namingsystem-type
dateRequiredΣ	1..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
responsible	0..1	string	Who maintains system namespace?
type	0..1	CodeableConcept	e.g. driver, provider, patient, bank etc.Binding (extensible): identifier-type
description	0..1	markdown	Natural language description of the naming system
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for naming system (if applicable)Binding (extensible): jurisdiction
usage	0..1	string	How/where is it used
uniqueIdRequiredΣ	1..*	BackboneElement	Unique identifiers used for system
typeRequiredΣ	1..1	code	oid | uuid | uri | otherBinding (required): namingsystem-identifier-type
valueRequiredΣ	1..1	string	The unique identifier
preferred	0..1	boolean	Is this the id that should be used for this type
comment	0..1	string	Notes about identifier usage
period	0..1	Period	When is identifier valid?

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/NamingSystem?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
contact	string	Name of an individual to contact NamingSystem.contact.name
context	token	A use context assigned to the naming system (NamingSystem.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the naming system (NamingSystem.useContext.value.ofType(Quantity)) | (NamingSystem.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the naming system NamingSystem.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the naming system NamingSystem.useContext
context-type-value	composite	A use context type and value assigned to the naming system NamingSystem.useContext
date	date	The naming system publication date NamingSystem.date
description	string	The description of the naming system NamingSystem.description
id-type	token	oid | uuid | uri | other NamingSystem.uniqueId.type
jurisdiction	token	Intended jurisdiction for the naming system NamingSystem.jurisdiction
kind	token	codesystem | identifier | root NamingSystem.kind
name	string	Computationally friendly name of the naming system NamingSystem.name
period	date	When is identifier valid? NamingSystem.uniqueId.period
publisher	string	Name of the publisher of the naming system NamingSystem.publisher
responsible	string	Who maintains system namespace? NamingSystem.responsible
status	token	The current status of the naming system NamingSystem.status
telecom	token	Contact details for individual or organization NamingSystem.contact.telecom
type	token	e.g. driver, provider, patient, bank etc. NamingSystem.type
value	string	The unique identifier NamingSystem.uniqueId.value

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition