Skip to main content

NamingSystem

Trial Use 1 Terminology

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.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/NamingSystem
InteractionMethodPath
ReadGET/fhir/R4/NamingSystem/[id]
VreadGET/fhir/R4/NamingSystem/[id]/_history/[vid]
UpdatePUT/fhir/R4/NamingSystem/[id]
PatchPATCH/fhir/R4/NamingSystem/[id]
DeleteDELETE/fhir/R4/NamingSystem/[id]
CreatePOST/fhir/R4/NamingSystem
SearchGET/fhir/R4/NamingSystem
HistoryGET/fhir/R4/NamingSystem/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
namestring1..1Name for this naming system (computer friendly)
statuscode1..1draft | active | retired | unknown modifier
kindcode1..1codesystem | identifier | root
datedateTime1..1Date last changed
publisherstring0..1Name of the publisher (organization or individual)
contactContactDetail0..*Contact details for the publisher
responsiblestring0..1Who maintains system namespace?
typeCodeableConcept0..1e.g. driver, provider, patient, bank etc.
descriptionmarkdown0..1Natural language description of the naming system
useContextUsageContext0..*The context that the content is intended to support
jurisdictionCodeableConcept0..*Intended jurisdiction for naming system (if applicable)
usagestring0..1How/where is it used
uniqueIdBackboneElement1..*Unique identifiers used for system

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
contactstringhttp://hl7.org/fhir/SearchParameter/NamingSystem-contact
contextstringhttp://hl7.org/fhir/SearchParameter/conformance-context
context-quantitystringhttp://hl7.org/fhir/SearchParameter/conformance-context-quantity
context-typestringhttp://hl7.org/fhir/SearchParameter/conformance-context-type
context-type-quantitystringhttp://hl7.org/fhir/SearchParameter/conformance-context-type-quantity
context-type-valuestringhttp://hl7.org/fhir/SearchParameter/conformance-context-type-value
datestringhttp://hl7.org/fhir/SearchParameter/conformance-date
descriptionstringhttp://hl7.org/fhir/SearchParameter/conformance-description
id-typestringhttp://hl7.org/fhir/SearchParameter/NamingSystem-id-type
jurisdictionstringhttp://hl7.org/fhir/SearchParameter/conformance-jurisdiction
kindstringhttp://hl7.org/fhir/SearchParameter/NamingSystem-kind
namestringhttp://hl7.org/fhir/SearchParameter/conformance-name
periodstringhttp://hl7.org/fhir/SearchParameter/NamingSystem-period
publisherstringhttp://hl7.org/fhir/SearchParameter/conformance-publisher
responsiblestringhttp://hl7.org/fhir/SearchParameter/NamingSystem-responsible
statusstringhttp://hl7.org/fhir/SearchParameter/conformance-status
telecomstringhttp://hl7.org/fhir/SearchParameter/NamingSystem-telecom
typestringhttp://hl7.org/fhir/SearchParameter/NamingSystem-type
valuestringhttp://hl7.org/fhir/SearchParameter/NamingSystem-value

Reference​

  • Official FHIR R4 spec: NamingSystem
  • Maturity: Trial Use 1 (FMM 1).