Data Model Libraries
    Preparing search index...

    Class ResearchElementDefinition

    ResearchElementDefinition Class

    The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

    Need to be able to define and reuse the definition of individual elements of a research question.

    FHIR Specification

    • Short: A population, intervention, or exposure definition
    • Definition: The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
    • Comment: PICO stands for Population (the population within which exposures are being compared), Intervention (the conditional state or exposure state being described for its effect on outcomes), Comparison (the alternative conditional state or alternative exposure state being compared against), and Outcome (the result or effect of the intervention in the population).
    • FHIR Version: 4.3.0

    FHIR ResearchElementDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? name? title? shortTitle? subtitle? publicationStatusEnum status experimental? subject? date? publisher? contact? description? comment? useContext? jurisdiction? purpose? usage? copyright? approvalDate? lastReviewDate? effectivePeriod? topic? author? editor? reviewer? endorser? relatedArtifact? library? researchElementTypeEnum type_ variableTypeEnum variableType? characteristic

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getShortTitleElement setShortTitleElement hasShortTitleElement getShortTitle setShortTitle hasShortTitle getSubtitleElement setSubtitleElement hasSubtitleElement getSubtitle setSubtitle hasSubtitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getSubject setSubject hasSubject getSubjectCodeableConcept hasSubjectCodeableConcept getSubjectReference hasSubjectReference getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getCommentElement setCommentElement addCommentElement hasCommentElement getComment setComment addComment hasComment getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getUsageElement setUsageElement hasUsageElement getUsage setUsage hasUsage getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getTopic setTopic addTopic hasTopic getAuthor setAuthor addAuthor hasAuthor getEditor setEditor addEditor hasEditor getReviewer setReviewer addReviewer hasReviewer getEndorser setEndorser addEndorser hasEndorser getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getLibraryElement setLibraryElement addLibraryElement hasLibraryElement getLibrary setLibrary addLibrary hasLibrary getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getVariableTypeEnumType setVariableTypeEnumType hasVariableTypeEnumType getVariableTypeElement setVariableTypeElement hasVariableTypeElement getVariableType setVariableType hasVariableType getCharacteristic setCharacteristic addCharacteristic hasCharacteristic fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContact initComment initUseContext initJurisdiction initTopic initAuthor initEditor initReviewer initEndorser initRelatedArtifact initLibrary initCharacteristic

    Constructors

    Properties

    url?: UriType

    ResearchElementDefinition.url Element

    FHIR Specification

    • Short: Canonical identifier for this research element definition, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the research element definition to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    ResearchElementDefinition.identifier Element

    FHIR Specification

    • Short: Additional identifier for the research element definition
    • Definition: A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this research element definition outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    ResearchElementDefinition.version Element

    FHIR Specification

    • Short: Business version of the research element definition
    • Definition: The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
    • Comment: There may be different research element definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the research element definition with the format [url]|[version].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    ResearchElementDefinition.name Element

    FHIR Specification

    • Short: Name for this research element definition (computer friendly)
    • Definition: A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    ResearchElementDefinition.title Element

    FHIR Specification

    • Short: Name for this research element definition (human friendly)
    • Definition: A short, descriptive, user-friendly title for the research element definition.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    shortTitle?: StringType

    ResearchElementDefinition.shortTitle Element

    FHIR Specification

    • Short: Title for use in informal contexts
    • Definition: The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
    • Requirements: Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subtitle?: StringType

    ResearchElementDefinition.subtitle Element

    FHIR Specification

    • Short: Subordinate title of the ResearchElementDefinition
    • Definition: An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    ResearchElementDefinition.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this research element definition. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of research element definitions that are appropriate for use versus not.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    ResearchElementDefinition.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • Comment: Allows filtering of research element definitions that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level research element definition.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: IDataType

    ResearchElementDefinition.subject[x] Element

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

    FHIR Specification

    • Short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    • Definition: The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.
    • Comment: The subject of the ResearchElementDefinition is critical in interpreting the criteria definitions, as the logic in the ResearchElementDefinitions is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content 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: false
    date?: DateTimeType

    ResearchElementDefinition.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes.
    • Comment: Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the research element definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    ResearchElementDefinition.publisher Element

    FHIR Specification

    • Short: Name of the publisher (organization or individual)
    • Definition: The name of the organization or individual that published the research element definition.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the research element definition is the organization or individual primarily responsible for the maintenance and upkeep of the research element definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the research element definition. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the research element definition. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    ResearchElementDefinition.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    ResearchElementDefinition.description Element

    FHIR Specification

    • Short: Natural language description of the research element definition
    • Definition: A free text natural language description of the research element definition from a consumer's perspective.
    • Comment: This description can be used to capture details such as why the research element definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the research element definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the research element definition is presumed to be the predominant language in the place the research element definition was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    comment?: StringType[]

    ResearchElementDefinition.comment Element

    FHIR Specification

    • Short: Used for footnotes or explanatory notes
    • Definition: A human-readable string to clarify or explain concepts about the resource.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    ResearchElementDefinition.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    ResearchElementDefinition.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for research element definition (if applicable)
    • Definition: A legal or geographic region in which the research element definition is intended to be used.
    • Comment: It may be possible for the research element definition to be used in jurisdictions other than those for which it was originally designed or intended.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    ResearchElementDefinition.purpose Element

    FHIR Specification

    • Short: Why this research element definition is defined
    • Definition: Explanation of why this research element definition is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the research element definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this research element definition.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    usage?: StringType

    ResearchElementDefinition.usage Element

    FHIR Specification

    • Short: Describes the clinical usage of the ResearchElementDefinition
    • Definition: A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    ResearchElementDefinition.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the research element definition and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    ResearchElementDefinition.approvalDate Element

    FHIR Specification

    • Short: When the research element definition was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    ResearchElementDefinition.lastReviewDate Element

    FHIR Specification

    • Short: When the research element definition was last reviewed
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    ResearchElementDefinition.effectivePeriod Element

    FHIR Specification

    • Short: When the research element definition is expected to be used
    • Definition: The period during which the research element definition content was or is planned to be in active use.
    • Comment: The effective period for a research element definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the research element definition are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    topic?: CodeableConcept[]

    ResearchElementDefinition.topic Element

    FHIR Specification

    • Short: The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
    • Definition: Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.
    • Requirements: Repositories must be able to determine how to categorize the ResearchElementDefinition so that it can be found by topical searches.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    author?: ContactDetail[]

    ResearchElementDefinition.author Element

    FHIR Specification

    • Short: Who authored the content
    • Definition: An individiual or organization primarily involved in the creation and maintenance of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    editor?: ContactDetail[]

    ResearchElementDefinition.editor Element

    FHIR Specification

    • Short: Who edited the content
    • Definition: An individual or organization primarily responsible for internal coherence of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    ResearchElementDefinition.reviewer Element

    FHIR Specification

    • Short: Who reviewed the content
    • Definition: An individual or organization primarily responsible for review of some aspect of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    ResearchElementDefinition.endorser Element

    FHIR Specification

    • Short: Who endorsed the content
    • Definition: An individual or organization responsible for officially endorsing the content for use in some setting.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    ResearchElementDefinition.relatedArtifact Element

    FHIR Specification

    • Short: Additional documentation, citations, etc.
    • Definition: Related artifacts such as additional documentation, justification, or bibliographic references.
    • Comment: Each related artifact is either an attachment, or a reference to another resource, but not both.
    • Requirements: ResearchElementDefinitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    library?: CanonicalType[]

    ResearchElementDefinition.library Element

    FHIR Specification

    • Short: Logic used by the ResearchElementDefinition
    • Definition: A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    researchElementTypeEnum: ResearchElementTypeEnum

    FHIR CodeSystem: ResearchElementType

    ResearchElementTypeEnum

    Privatetype_

    type_: null | EnumCodeType

    ResearchElementDefinition.type Element

    FHIR Specification

    • Short: population | exposure | outcome
    • Definition: The type of research element, a population, an exposure, or an outcome.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ResearchElementTypeEnum

    variableTypeEnum: VariableTypeEnum

    FHIR CodeSystem: VariableType

    VariableTypeEnum

    variableType?: EnumCodeType

    ResearchElementDefinition.variableType Element

    FHIR Specification

    • Short: dichotomous | continuous | descriptive
    • Definition: The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: VariableTypeEnum

    characteristic: null | ResearchElementDefinitionCharacteristicComponent[]

    ResearchElementDefinition.characteristic Element

    FHIR Specification

    • Short: What defines the members of the research element
    • Definition: A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics.
    • Comment: Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ResearchElementDefinition

      • OptionaloptSourceField: string

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

      Returns undefined | ResearchElementDefinition

      ResearchElementDefinition data model or undefined for ResearchElementDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetShortTitleElementsetShortTitleElementhasShortTitleElementgetShortTitlesetShortTitlehasShortTitlegetSubtitleElementsetSubtitleElementhasSubtitleElementgetSubtitlesetSubtitlehasSubtitlegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetSubjectsetSubjecthasSubjectgetSubjectCodeableConcepthasSubjectCodeableConceptgetSubjectReferencehasSubjectReferencegetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetCommentElementsetCommentElementaddCommentElementhasCommentElementgetCommentsetCommentaddCommenthasCommentgetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetUsageElementsetUsageElementhasUsageElementgetUsagesetUsagehasUsagegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetEffectivePeriodsetEffectivePeriodhasEffectivePeriodgetTopicsetTopicaddTopichasTopicgetAuthorsetAuthoraddAuthorhasAuthorgetEditorsetEditoraddEditorhasEditorgetReviewersetRevieweraddReviewerhasReviewergetEndorsersetEndorseraddEndorserhasEndorsergetRelatedArtifactsetRelatedArtifactaddRelatedArtifacthasRelatedArtifactgetLibraryElementsetLibraryElementaddLibraryElementhasLibraryElementgetLibrarysetLibraryaddLibraryhasLibrarygetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetVariableTypeEnumTypesetVariableTypeEnumTypehasVariableTypeEnumTypegetVariableTypeElementsetVariableTypeElementhasVariableTypeElementgetVariableTypesetVariableTypehasVariableTypegetCharacteristicsetCharacteristicaddCharacteristichasCharacteristicfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitContactinitCommentinitUseContextinitJurisdictioninitTopicinitAuthorinitEditorinitReviewerinitEndorserinitRelatedArtifactinitLibraryinitCharacteristic