Data Model Libraries
    Preparing search index...

    GraphDefinitionLinkComponent Class

    FHIR Specification

    • Short: Links this graph makes rules about
    • Definition: Links this graph makes rules about.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    GraphDefinition.link.description Element

    FHIR Specification

    • Short: Why this link is specified
    • Definition: Information about why this link is of interest in this graph definition.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    GraphDefinition.link.min Element

    FHIR Specification

    • Short: Minimum occurrences for this link
    • Definition: Minimum occurrences for this link.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    GraphDefinition.link.max Element

    FHIR Specification

    • Short: Maximum occurrences for this link
    • Definition: Maximum occurrences for this link.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    sourceId: null | IdType

    GraphDefinition.link.sourceId Element

    FHIR Specification

    • Short: Source Node for this link
    • Definition: The source node for this link.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    path?: StringType

    GraphDefinition.link.path Element

    FHIR Specification

    • Short: Path in the resource that contains the link
    • Definition: A FHIRPath expression that identifies one of FHIR References to other resources.
    • Comment: The path expression cannot contain a resolve() function. If there is no path, the link is a reverse lookup, using target.params. If the path is "*" then this means all references in the resource.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    sliceName?: StringType

    GraphDefinition.link.sliceName Element

    FHIR Specification

    • Short: Which slice (if profiled)
    • Definition: Which slice (if profiled).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    targetId: null | IdType

    GraphDefinition.link.targetId Element

    FHIR Specification

    • Short: Target Node for this link
    • Definition: The target node for this link.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    params?: StringType

    GraphDefinition.link.params Element

    FHIR Specification

    • Short: Criteria for reverse lookup
    • Definition: A set of parameters to look up.
    • Comment: At least one of the parameters must have the value {ref} which identifies the focus resource.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    GraphDefinition.link.compartment Element

    FHIR Specification

    • Short: Compartment Consistency Rules
    • Definition: Compartment Consistency Rules.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR GraphDefinitionLinkComponent

      • OptionaloptSourceField: string

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

      Returns undefined | GraphDefinitionLinkComponent

      GraphDefinitionLinkComponent data model or undefined for GraphDefinitionLinkComponent

      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