Release 4

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Operation-namingsystem-preferred-id

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

Fetch Preferred it

OPERATION: Fetch Preferred it

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/NamingSystem-preferred-id

This operation returns the preferred identifiers for identifiers, and terminologies. The operation takes 2 parameters:

  • a system identifier - either a URI, an OID, or a v2 table 0396 (other) code
  • a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier)

and returns either the requested identifier, or an HTTP errors response with an OperationOutcome because either the provided identifier was not recognized, or the requested identiifer type is not known.

The principle use of this operation is when converting between v2, CDA and FHIR Identifier/CX/II and CodeableConcepts/C(N/W)E/CD but the operation may also find use when converting metadata such as profiles.

URL: [base]/NamingSystem/$preferred-id

Parameters

UseNameCardinalityTypeBindingDocumentation
INid1..1string

The server parses the provided id to see what type it is (mary a URI, an OID as a URI, a plain OID, or a v2 table 0396 code). If the server can't tell what type of identifier it is, it can try it as multiple types. It is an error if more than one system matches the provided identifier

INtype1..1codehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1 (Required)
OUTresult1..1string

OIDs are return as plain OIDs (not the URI form).

Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type (NamingSystem.uniqueId.type). If there are multiple possible identifiers of the specified type (e.g. multiple OIDs) the server returns an error.

If the server wishes, it can also look through all code systems and value sets it knows about when attempting to find the requested identifier

 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.