Developer documentation‎ > ‎FHIR API‎ > ‎Roadmap‎ > ‎

NamingSystem

This is a draft document. Please be aware that the contents are subject to change.

FHIR NamingSystem Resource

https://www.hl7.org/fhir/namingsystem.html

Overview

The NamingSystem resource allows us to provide extra information about a Local ID, such as the textual display name.

Relevant Entities

Endpoints

Protection CategoryInteractionHTTPURLSupported Search ParamsPermitted User TypesDescriptionExamples
Non ClinicalsearchGET/NamingSystem
  • value. Required. Multi-value support: none. Modifier support: [exact].
  • Patient
  • Professional
Lookup the NamingSystem for a given canonical URL./NamingSystem?value=urn:uuid:641f3ea4-6205-4c7a-8d80-9fcb25d55287

Mappings

FHIRPKBNotes
Resource id<conditional>
If this represents an Organisation Level ID Type:  [[Organisation Level ID Type.Public ID]]
Else if this represents a Team Level ID Type: [[Team Level ID Type.Public ID]]
 
NamingSystem.name<conditional>
If this represents an Organisation Level ID Type: [[Organisation Level ID Type.Name]]
Else if this represents a Team Level ID Type: [[Team Level ID Type.Name]]
 
NamingSystem.status"active" 
NamingSystem.kind"identifier" 
NamingSystem.dateCurrent date, e.g. 2017-09-09  
NamingSystem.uniqueId
  • uniqueId: BackboneElement
    • type = "uri"
    • value = "urn:uuid:" + Resource id 
The uniqueId value is the value that is returned to callers in Identifier.system alongside an identifier. Callers can then attempt to retrieve additional information about the namespace (in the form of a NamingSystem resource) by providing this value in the "value" search param.

See FHIR API Terminology for more info.

Comments