Data Model Libraries
    Preparing search index...

    NamingSystemUniqueIdComponent Class

    FHIR Specification

    • Short: Unique identifiers used for system
    • Definition: Indicates how the system may be identified when referenced in electronic exchange.
    • Comment: Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    namingsystemIdentifierTypeEnum: NamingsystemIdentifierTypeEnum

    FHIR CodeSystem: NamingsystemIdentifierType

    type_: null | EnumCodeType

    NamingSystem.uniqueId.type Element

    FHIR Specification

    • Short: oid | uuid | uri | other
    • Definition: Identifies the unique identifier scheme used for this particular identifier.
    • Comment: Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: NamingsystemIdentifierTypeEnum

    value: null | StringType

    NamingSystem.uniqueId.value Element

    FHIR Specification

    • Short: The unique identifier
    • Definition: The string that should be sent over the wire to identify the code system or identifier system.
    • Comment: If the value is a URI intended for use as FHIR system identifier, the URI should not contain "" or "?" or "," since this makes escaping very difficult.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    preferred?: BooleanType

    NamingSystem.uniqueId.preferred Element

    FHIR Specification

    • Short: Is this the id that should be used for this type
    • Definition: Indicates whether this identifier is the "preferred" identifier of this type.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    comment?: StringType

    NamingSystem.uniqueId.comment Element

    FHIR Specification

    • Short: Notes about identifier usage
    • Definition: Notes about the past or intended usage of this identifier.
    • Comment: e.g. "must be used in Germany" or "was initially published in error with this value".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    period?: Period

    NamingSystem.uniqueId.period Element

    FHIR Specification

    • Short: When is identifier valid?
    • Definition: Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.
    • Comment: Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided NamingSystemUniqueIdComponent JSON to instantiate the NamingSystemUniqueIdComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR NamingSystemUniqueIdComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to NamingSystemUniqueIdComponent

      Returns undefined | NamingSystemUniqueIdComponent

      NamingSystemUniqueIdComponent data model or undefined for NamingSystemUniqueIdComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise