Data Model Libraries
    Preparing search index...

    Class DataRequirement

    DataRequirement Class

    Base StructureDefinition for DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

    FHIR Specification

    • Short: Describes a required data item
    • Definition: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
    • FHIR Version: 4.0.1

    FHIR DataRequirement

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_ profile? subject? mustSupport? codeFilter? dateFilter? limit? sort?

    Methods

    parse getTypeElement setTypeElement hasTypeElement getType setType hasType getProfileElement setProfileElement addProfileElement hasProfileElement getProfile setProfile addProfile hasProfile getSubject setSubject hasSubject getSubjectCodeableConcept hasSubjectCodeableConcept getSubjectReference hasSubjectReference getMustSupportElement setMustSupportElement addMustSupportElement hasMustSupportElement getMustSupport setMustSupport addMustSupport hasMustSupport getCodeFilter setCodeFilter addCodeFilter hasCodeFilter getDateFilter setDateFilter addDateFilter hasDateFilter getLimitElement setLimitElement hasLimitElement getLimit setLimit hasLimit getSort setSort addSort hasSort fhirType isEmpty isRequiredFieldsEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initProfile initMustSupport initCodeFilter initDateFilter initSort

    Constructors

    Properties

    Privatetype_

    type_: null | CodeType

    DataRequirement.type Element

    FHIR Specification

    • Short: The type of the required data
    • Definition: The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    profile?: CanonicalType[]

    DataRequirement.profile Element

    FHIR Specification

    subject?: IDataType

    DataRequirement.subject[x] Element

    @ChoiceDataTypesMeta('DataRequirement.subject[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    • Definition: The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
    • Comment: The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    mustSupport?: StringType[]

    DataRequirement.mustSupport Element

    FHIR Specification

    • Short: Indicates specific structure elements that are referenced by the knowledge module
    • Definition: Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    codeFilter?: DataRequirementCodeFilterComponent[]

    DataRequirement.codeFilter Element

    FHIR Specification

    • Short: What codes are expected
    • Definition: Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    dateFilter?: DataRequirementDateFilterComponent[]

    DataRequirement.dateFilter Element

    FHIR Specification

    • Short: What dates/date ranges are expected
    • Definition: Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    limit?: PositiveIntType

    DataRequirement.limit Element

    FHIR Specification

    • Short: Number of results
    • Definition: Specifies a maximum number of results that are required (uses the _count search parameter).
    • Comment: This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
    • Requirements: Enables the requirement "most recent 5 results" to be expressed.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    sort?: DataRequirementSortComponent[]

    DataRequirement.sort Element

    FHIR Specification

    • Short: Order of the results
    • Definition: Specifies the order of the results to be returned.
    • Comment: This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
    • Requirements: Enables the requirement "most recent 5 results" to be expressed.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DataRequirement

      • OptionaloptSourceField: string

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

      Returns undefined | DataRequirement

      DataRequirement data model or undefined for DataRequirement

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

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

    • 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

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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 resource; false otherwise

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetProfileElementsetProfileElementaddProfileElementhasProfileElementgetProfilesetProfileaddProfilehasProfilegetSubjectsetSubjecthasSubjectgetSubjectCodeableConcepthasSubjectCodeableConceptgetSubjectReferencehasSubjectReferencegetMustSupportElementsetMustSupportElementaddMustSupportElementhasMustSupportElementgetMustSupportsetMustSupportaddMustSupporthasMustSupportgetCodeFiltersetCodeFilteraddCodeFilterhasCodeFiltergetDateFiltersetDateFilteraddDateFilterhasDateFiltergetLimitElementsetLimitElementhasLimitElementgetLimitsetLimithasLimitgetSortsetSortaddSorthasSortfhirTypeisEmptyisRequiredFieldsEmptycopyisComplexDataTypedataTypeNametoJSONisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitProfileinitMustSupportinitCodeFilterinitDateFilterinitSort