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 . Page versions: R5 R4B R4

Example OperationDefinition/NamingSystem-preferred-id (Narrative)

Vocabulary 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.

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

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INid1..1string

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

INtype1..1codehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0-ballot (Required)
INdate0..1dateTime

If specified, the operation will indicate what the preferred identifier was on the specified date. If not specified, the operation will provide the preferred identifier as of 'now'

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 is more than one identifier of the specified type (for the specified date), then the 'preferred' identifier will be returned. If there is only one identifier, that identifier will be returned even if it is not preferred. If there are multiple preferred identifiers or multiple identifiers with none marked as preferred, the system MAY return an error or may list all identifiers applicable for that date and period.

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.