Data Model Libraries
    Preparing search index...

    ObservationDefinition Class

    Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

    In a catalog of health-related services that use or produce observations and measurements, this resource describes the expected characteristics of these observation / measurements.

    FHIR Specification

    • Short: Definition of an observation
    • Definition: Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
    • Comment: An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getVersionAlgorithm setVersionAlgorithm hasVersionAlgorithm getVersionAlgorithmStringType hasVersionAlgorithmStringType getVersionAlgorithmCoding hasVersionAlgorithmCoding getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getCopyrightLabelElement setCopyrightLabelElement hasCopyrightLabelElement getCopyrightLabel setCopyrightLabel hasCopyrightLabel getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getDerivedFromCanonicalElement setDerivedFromCanonicalElement addDerivedFromCanonicalElement hasDerivedFromCanonicalElement getDerivedFromCanonical setDerivedFromCanonical addDerivedFromCanonical hasDerivedFromCanonical getDerivedFromUriElement setDerivedFromUriElement addDerivedFromUriElement hasDerivedFromUriElement getDerivedFromUri setDerivedFromUri addDerivedFromUri hasDerivedFromUri getSubject setSubject addSubject hasSubject getPerformerType setPerformerType hasPerformerType getCategory setCategory addCategory hasCategory getCode setCode hasCode getPermittedDataTypeEnumType setPermittedDataTypeEnumType addPermittedDataTypeEnumType hasPermittedDataTypeEnumType getPermittedDataTypeElement setPermittedDataTypeElement addPermittedDataTypeElement hasPermittedDataTypeElement getPermittedDataType setPermittedDataType addPermittedDataType hasPermittedDataType getMultipleResultsAllowedElement setMultipleResultsAllowedElement hasMultipleResultsAllowedElement getMultipleResultsAllowed setMultipleResultsAllowed hasMultipleResultsAllowed getBodySite setBodySite hasBodySite getMethod setMethod hasMethod getSpecimen setSpecimen addSpecimen hasSpecimen getDevice setDevice addDevice hasDevice getPreferredReportNameElement setPreferredReportNameElement hasPreferredReportNameElement getPreferredReportName setPreferredReportName hasPreferredReportName getPermittedUnit setPermittedUnit addPermittedUnit hasPermittedUnit getQualifiedValue setQualifiedValue addQualifiedValue hasQualifiedValue getHasMember setHasMember addHasMember hasHasMember getComponent setComponent addComponent hasComponent 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 initContact initUseContext initJurisdiction initDerivedFromCanonical initDerivedFromUri initSubject initCategory initPermittedDataType initSpecimen initDevice initPermittedUnit initQualifiedValue initHasMember initComponent

    Constructors

    Properties

    url?: UriType

    ObservationDefinition.url Element

    FHIR Specification

    • Short: Logical canonical URL to reference this ObservationDefinition (globally unique)
    • Definition: An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.
    • Comment: Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.
    • Requirements: Allows the ObservationDefinition to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier

    ObservationDefinition.identifier Element

    FHIR Specification

    • Short: Business identifier of the ObservationDefinition
    • Definition: Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.
    • Requirements: Allows identification of the ObservationDefinition as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    version?: StringType

    ObservationDefinition.version Element

    FHIR Specification

    • Short: Business version of the ObservationDefinition
    • Definition: The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition 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 are orderable.
    • Comment: There may be multiple different instances of an observationDefinition that have the same identifier but different versions.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionAlgorithm?: IDataType

    ObservationDefinition.versionAlgorithm[x] Element

    @ChoiceDataTypesMeta('ObservationDefinition.versionAlgorithm[x]', ['string','Coding',]

    FHIR Specification

    • Short: How to compare versions
    • Definition: Indicates the mechanism used to compare versions to determine which is more current.
    • Comment: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
    • FHIR Types: 'string', 'Coding',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    FHIR Specification

    • Short: Name for this ObservationDefinition (computer friendly)
    • Definition: A natural language name identifying the ObservationDefinition. 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

    ObservationDefinition.title Element

    FHIR Specification

    • Short: Name for this ObservationDefinition (human friendly)
    • Definition: A short, descriptive, user-friendly title for the ObservationDefinition.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    status: null | EnumCodeType

    ObservationDefinition.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The current state of the ObservationDefinition.
    • Comment: A nominal state-transition diagram can be found in the Definition pattern documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: Not known why this is labelled a modifier
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    ObservationDefinition.experimental Element

    FHIR Specification

    • Short: If for testing purposes, not real usage
    • Definition: A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
    • Comment: Allows filtering of ObservationDefinition that are appropriate for use vs. not.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ObservationDefinition.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the ObservationDefinition was last significantly changed. 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 ObservationDefinition changes.
    • Comment: The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the ObservationDefinition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    ObservationDefinition.publisher Element

    FHIR Specification

    • Short: The name of the individual or organization that published the ObservationDefinition
    • Definition: Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.
    • Requirements: Usually an organization, but may be an individual. The publisher (or steward) of the ObservationDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the ObservationDefinition. 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 ObservationDefinition. This item SHOULD be populated unless the information is available from context.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    ObservationDefinition.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. See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    ObservationDefinition.description Element

    FHIR Specification

    • Short: Natural language description of the ObservationDefinition
    • Definition: A free text natural language description of the ObservationDefinition from the consumer's perspective.
    • Comment: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    ObservationDefinition.useContext Element

    FHIR Specification

    • Short: Content intends to support these contexts
    • 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 ObservationDefinition instances.
    • Comment: When multiple usageContexts are specified, there is no expectation for whether 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[]

    ObservationDefinition.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for this ObservationDefinition (if applicable)
    • Definition: A jurisdiction in which the ObservationDefinition is intended to be used.
    • Comment: It may be possible for the ObservationDefinition to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    ObservationDefinition.purpose Element

    FHIR Specification

    • Short: Why this ObservationDefinition is defined
    • Definition: Explains why this ObservationDefinition is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the ObservationDefinition. Rather it is for 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 ObservationDefinition.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    ObservationDefinition.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.
    • Requirements: Consumers of the ObservationDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyrightLabel?: StringType

    ObservationDefinition.copyrightLabel Element

    FHIR Specification

    • Short: Copyright holder and year(s)
    • Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
    • Comment: The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
    • Requirements: Defines the content expected to be rendered in all representations of the artifact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    ObservationDefinition.approvalDate Element

    FHIR Specification

    • Short: When ObservationDefinition was approved by publisher
    • Definition: The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The date may be more recent than the approval date because of minor changes / editorial corrections. See guidance around (not) making local changes to elements here.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    ObservationDefinition.lastReviewDate Element

    FHIR Specification

    • Short: Date on which the asset content was last reviewed by the publisher
    • Definition: The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
    • Comment: If specified, this is usually after the approval date. See guidance around (not) making local changes to elements here.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    ObservationDefinition.effectivePeriod Element

    FHIR Specification

    • Short: The effective date range for the ObservationDefinition
    • Definition: The period during which the ObservationDefinition content was or is planned to be effective.
    • Comment: The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation definition intended to be used for the year 2021 might be published in 2020. See guidance around (not) making local changes to elements here.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    derivedFromCanonical?: CanonicalType[]

    ObservationDefinition.derivedFromCanonical Element

    FHIR Specification

    • Short: Based on FHIR definition of another observation
    • Definition: The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    derivedFromUri?: UriType[]

    ObservationDefinition.derivedFromUri Element

    FHIR Specification

    • Short: Based on external definition
    • Definition: The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.
    • Requirements: Observation definitions may be refinements of other definitions.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: CodeableConcept[]

    ObservationDefinition.subject Element

    FHIR Specification

    • Short: Type of subject for the defined observation
    • Definition: A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.
    • Comment: Examples: person, animal, device, air, surface ....
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    performerType?: CodeableConcept

    ObservationDefinition.performerType Element

    FHIR Specification

    • Short: Desired kind of performer for such kind of observation
    • Definition: The type of individual/organization/device that is expected to act upon instances of this definition.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    category?: CodeableConcept[]

    ObservationDefinition.category Element

    FHIR Specification

    • Short: General type of observation
    • Definition: A code that classifies the general type of observation.
    • Comment: This element allows various categorization schemes based on the owner's definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.
    • Requirements: Used for filtering what kinds of observations are retrieved and displayed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    code: null | CodeableConcept

    ObservationDefinition.code Element

    FHIR Specification

    • Short: Type of observation
    • Definition: Describes what will be observed. Sometimes this is called the observation "name".
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    permittedDataTypeEnum: PermittedDataTypeEnum

    FHIR CodeSystem: PermittedDataType

    permittedDataType?: EnumCodeType[]

    ObservationDefinition.permittedDataType Element

    FHIR Specification

    • Short: Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
    • Definition: The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: PermittedDataTypeEnum

    multipleResultsAllowed?: BooleanType

    ObservationDefinition.multipleResultsAllowed Element

    FHIR Specification

    • Short: Multiple results allowed for conforming observations
    • Definition: Multiple results allowed for observations conforming to this ObservationDefinition.
    • Comment: An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    bodySite?: CodeableConcept

    ObservationDefinition.bodySite Element

    FHIR Specification

    • Short: Body part to be observed
    • Definition: The site on the subject's body where the observation is to be made.
    • Comment: Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. Example: 14975008 |Forearm structure|.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ObservationDefinition.method Element

    FHIR Specification

    • Short: Method used to produce the observation
    • Definition: The method or technique used to perform the observation.
    • Comment: Only used if not implicit in observation code Example: 702659008 |Automated count technique|.
    • Requirements: In some cases, method can impact results.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    specimen?: Reference[]

    ObservationDefinition.specimen Element

    FHIR Specification

    • Short: Kind of specimen used by this type of observation
    • Definition: The kind of specimen that this type of observation is produced on.
    • Comment: Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    device?: Reference[]

    ObservationDefinition.device Element

    FHIR Specification

    • Short: Measurement device or model of device
    • Definition: The measurement model of device or actual device used to produce observations of this type.
    • Comment: When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    preferredReportName?: StringType

    ObservationDefinition.preferredReportName Element

    FHIR Specification

    • Short: The preferred name to be used when reporting the observation results
    • Definition: The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    permittedUnit?: Coding[]

    ObservationDefinition.permittedUnit Element

    FHIR Specification

    • Short: Unit for quantitative results
    • Definition: Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ObservationDefinition.qualifiedValue Element

    FHIR Specification

    • Short: Set of qualified values for observation results
    • Definition: A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    hasMember?: Reference[]

    ObservationDefinition.hasMember Element

    FHIR Specification

    ObservationDefinition.component Element

    FHIR Specification

    • Short: Component results
    • Definition: Some observations have multiple component observations, expressed as separate code value pairs.
    • Requirements: Component observations share the same attributes as the primary observation and are always treated as a part of it (they are not separable).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ObservationDefinition

      • OptionaloptSourceField: string

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

      Returns undefined | ObservationDefinition

      ObservationDefinition data model or undefined for ObservationDefinition

      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