Data Model Libraries
    Preparing search index...

    TransportRestrictionComponent Class

    FHIR Specification

    • Short: Constraints on fulfillment transports
    • Definition: If the Transport.focus is a request resource and the transport is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
    • Requirements: Sometimes when fulfillment is sought, you don't want full fulfillment.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    repetitions?: PositiveIntType

    Transport.restriction.repetitions Element

    FHIR Specification

    • Short: How many times to repeat
    • Definition: Indicates the number of times the requested action should occur.
    • Requirements: E.g. order that requests monthly lab tests, fulfillment is sought for 1.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    period?: Period

    Transport.restriction.period Element

    FHIR Specification

    • Short: When fulfillment sought
    • Definition: Over what time-period is fulfillment sought.
    • Comment: Note that period.high is the due date representing the time by which the transport should be completed.
    • Requirements: E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recipient?: Reference[]

    Transport.restriction.recipient Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TransportRestrictionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TransportRestrictionComponent

      TransportRestrictionComponent data model or undefined for TransportRestrictionComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the recipient property.

      Parameters

      • value: undefined | Reference[]

        the recipient array value

      Returns this

      this

      @ReferenceTargets('Transport.restriction.recipient', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Group','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the recipient array property.

      Parameters

      • value: undefined | Reference

        the recipient value

      Returns this

      this

      @ReferenceTargets('Transport.restriction.recipient', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Group','Organization',])

      InvalidTypeError for invalid data type or reference value

    • 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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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