Data Model Libraries
    Preparing search index...

    ParametersParameterComponent Class

    FHIR Specification

    • Short: Operation Parameter
    • Definition: A parameter passed to or received from the operation.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getNameElement setNameElement hasNameElement getName setName hasName getValue setValue hasValue getValueBase64BinaryType hasValueBase64BinaryType getValueBooleanType hasValueBooleanType getValueCanonicalType hasValueCanonicalType getValueCodeType hasValueCodeType getValueDateType hasValueDateType getValueDateTimeType hasValueDateTimeType getValueDecimalType hasValueDecimalType getValueIdType hasValueIdType getValueInstantType hasValueInstantType getValueIntegerType hasValueIntegerType getValueMarkdownType hasValueMarkdownType getValueOidType hasValueOidType getValuePositiveIntType hasValuePositiveIntType getValueStringType hasValueStringType getValueTimeType hasValueTimeType getValueUnsignedIntType hasValueUnsignedIntType getValueUriType hasValueUriType getValueUrlType hasValueUrlType getValueUuidType hasValueUuidType getValueAddress hasValueAddress getValueAge hasValueAge getValueAnnotation hasValueAnnotation getValueAttachment hasValueAttachment getValueCodeableConcept hasValueCodeableConcept getValueCoding hasValueCoding getValueContactPoint hasValueContactPoint getValueCount hasValueCount getValueDistance hasValueDistance getValueDuration hasValueDuration getValueHumanName hasValueHumanName getValueIdentifier hasValueIdentifier getValueMoney hasValueMoney getValuePeriod hasValuePeriod getValueQuantity hasValueQuantity getValueRange hasValueRange getValueRatio hasValueRatio getValueReference hasValueReference getValueSampledData hasValueSampledData getValueSignature hasValueSignature getValueTiming hasValueTiming getValueContactDetail hasValueContactDetail getValueContributor hasValueContributor getValueDataRequirement hasValueDataRequirement getValueExpression hasValueExpression getValueParameterDefinition hasValueParameterDefinition getValueRelatedArtifact hasValueRelatedArtifact getValueTriggerDefinition hasValueTriggerDefinition getValueUsageContext hasValueUsageContext getValueDosage hasValueDosage getValueMeta hasValueMeta getResource setResource hasResource getPart setPart addPart hasPart fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initPart

    Constructors

    Properties

    name: null | StringType

    FHIR Specification

    • Short: Name from the definition
    • Definition: The name of the parameter (reference to the operation definition).
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    value?: IDataType

    Parameters.parameter.value[x] Element

    @ChoiceDataTypesMeta('Parameters.parameter.value[x]', ['base64Binary','boolean','canonical','code','date','dateTime','decimal','id','instant','integer','markdown','oid','positiveInt','string','time','unsignedInt','uri','url','uuid','Address','Age','Annotation','Attachment','CodeableConcept','Coding','ContactPoint','Count','Distance','Duration','HumanName','Identifier','Money','Period','Quantity','Range','Ratio','Reference','SampledData','Signature','Timing','ContactDetail','Contributor','DataRequirement','Expression','ParameterDefinition','RelatedArtifact','TriggerDefinition','UsageContext','Dosage','Meta',]

    FHIR Specification

    • Short: If parameter is a data type
    • Definition: If the parameter is a data type.
    • FHIR Types: 'base64Binary', 'boolean', 'canonical', 'code', 'date', 'dateTime', 'decimal', 'id', 'instant', 'integer', 'markdown', 'oid', 'positiveInt', 'string', 'time', 'unsignedInt', 'uri', 'url', 'uuid', 'Address', 'Age', 'Annotation', 'Attachment', 'CodeableConcept', 'Coding', 'ContactPoint', 'Count', 'Distance', 'Duration', 'HumanName', 'Identifier', 'Money', 'Period', 'Quantity', 'Range', 'Ratio', 'Reference', 'SampledData', 'Signature', 'Timing', 'ContactDetail', 'Contributor', 'DataRequirement', 'Expression', 'ParameterDefinition', 'RelatedArtifact', 'TriggerDefinition', 'UsageContext', 'Dosage', 'Meta',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resource?: IResource

    Parameters.parameter.resource Element

    FHIR Specification

    • Short: If parameter is a whole resource
    • Definition: If the parameter is a whole resource.
    • Comment: When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
    • FHIR Type: Resource
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Parameters.parameter.part Element

    FHIR Specification

    • Short: Named part of a multi-part parameter
    • Definition: A named part of a multi-part parameter.
    • Comment: Only one level of nested parameters is allowed.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ParametersParameterComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ParametersParameterComponent

      ParametersParameterComponent data model or undefined for ParametersParameterComponent

      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