Operation-namingsystem-translate-id

Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example OperationDefinition/NamingSystem-translate-id (Narrative)

Vocabulary Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

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

Note that this is the formal definition for the translate-id operation as an OperationDefinition on NamingSystem. See the Operation documentation

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

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

id

1..1

string

The server parses the provided identifier to see what type it is (e.g. 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

IN

sourceType

1..1

code

http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0-ballot (Required)

IN

targetType

1..1

code

http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0-ballot (Required)

IN

preferredOnly

0..1

boolean

If preferredOnly = true then return only the preferred identifier, or if preferredOnly = false then return all available ids.

IN

date

0..1

dateTime

If 'date' is supplied return only ids that have a validity period that includes that date.

OUT

result

1..1

boolean

True if the identifier could be translated successfully.

OUT

targetIdentifier

0..*

boolean

The target identifer(s) of the requested type

OUT

targetIdentifer.preferred

0..1

boolean

Whether the target identifier is preferred.

OUT

targetIdentifier.period

0..1

boolean

The perioid when the target identifier is valid.

Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type (NamingSystem.uniqueId.type).

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.