Data Model Libraries
    Preparing search index...

    Class Meta

    Meta Class

    Base StructureDefinition for Meta Type: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

    FHIR Specification

    • Short: Metadata about a resource
    • Definition: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
    • FHIR Version: 4.0.1

    FHIR Meta

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    versionId? lastUpdated? source? profile? security? tag? initProfile initSecurity initTag

    Methods

    parse getVersionIdElement setVersionIdElement hasVersionIdElement getVersionId setVersionId hasVersionId getLastUpdatedElement setLastUpdatedElement hasLastUpdatedElement getLastUpdated setLastUpdated hasLastUpdated getSourceElement setSourceElement hasSourceElement getSource setSource hasSource getProfileElement setProfileElement addProfileElement hasProfileElement getProfile setProfile addProfile hasProfile getSecurity setSecurity addSecurity hasSecurity getTag setTag addTag hasTag fhirType isEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    versionId?: any

    Meta.versionId Element

    FHIR Specification

    • Short: Version specific identifier
    • Definition: The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
    • Comment: The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    lastUpdated?: any

    Meta.lastUpdated Element

    FHIR Specification

    • Short: When the resource version last changed
    • Definition: When the resource last changed - e.g. when the version changed.
    • Comment: This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    source?: any

    Meta.source Element

    FHIR Specification

    • Short: Identifies where the resource comes from
    • Definition: A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
    • Comment: In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    profile?: any

    Meta.profile Element

    FHIR Specification

    • Short: Profiles this resource claims to conform to
    • Definition: A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
    • Comment: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    security?: any

    Meta.security Element

    FHIR Specification

    • Short: Security Labels applied to this resource
    • Definition: Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
    • Comment: The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    tag?: any

    Meta.tag Element

    FHIR Specification

    • Short: Tags applied to this resource
    • Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
    • Comment: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    initProfile: any

    Initialize the profile property

    initSecurity: any

    Initialize the security property

    initTag: any

    Initialize the tag property

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Meta

      • OptionaloptSourceField: string

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

      Returns undefined | Meta

      Meta data model or undefined for Meta

      JsonError if the provided JSON is not a valid JSON object

    • Returns IdType

      the versionId property value as a IdType object if defined; else an empty IdType object

    • Assigns the provided PrimitiveType value to the versionId property.

      Parameters

      • element: undefined | IdType

        the versionId value

      Returns this

      this

    • Returns boolean

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

    • Returns undefined | string

      the versionId property value as a fhirId if defined; else undefined

    • Assigns the provided primitive value to the versionId property.

      Parameters

      • value: undefined | string

        the versionId value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

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

    • Returns InstantType

      the lastUpdated property value as a InstantType object if defined; else an empty InstantType object

    • Assigns the provided PrimitiveType value to the lastUpdated property.

      Parameters

      Returns this

      this

    • Returns boolean

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

    • Returns undefined | string

      the lastUpdated property value as a fhirInstant if defined; else undefined

    • Assigns the provided primitive value to the lastUpdated property.

      Parameters

      • value: undefined | string

        the lastUpdated value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

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

    • Returns UriType

      the source property value as a UriType object if defined; else an empty UriType object

    • Assigns the provided PrimitiveType value to the source property.

      Parameters

      • element: undefined | UriType

        the source value

      Returns this

      this

    • Returns boolean

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

    • Returns undefined | string

      the source property value as a fhirUri if defined; else undefined

    • Assigns the provided primitive value to the source property.

      Parameters

      • value: undefined | string

        the source value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

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

    • Returns CanonicalType[]

      the profile property value as a CanonicalType array

    • Assigns the provided CanonicalType array value to the profile property.

      Parameters

      Returns this

      this

    • Add the provided CanonicalType value to the profile array property.

      Parameters

      Returns this

      this

    • Returns boolean

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

    • Returns string[]

      the profile property value as a fhirCanonical array

    • Assigns the provided primitive value array to the profile property.

      Parameters

      • value: undefined | string[]

        the profile value array

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Add the provided primitive value to the profile array property.

      Parameters

      • value: undefined | string

        the profile value

      Returns this

      this

    • Returns boolean

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

    • Returns Coding[]

      the security property value as a Coding array

    • Assigns the provided Coding array value to the security property.

      Parameters

      • value: undefined | Coding[]

        the security array value

      Returns this

      this

    • Add the provided Coding value to the security array property.

      Parameters

      • value: undefined | Coding

        the security value

      Returns this

      this

    • Returns boolean

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

    • Returns Coding[]

      the tag property value as a Coding array

    • Assigns the provided Coding array value to the tag property.

      Parameters

      • value: undefined | Coding[]

        the tag array value

      Returns this

      this

    • Add the provided Coding value to the tag array property.

      Parameters

      • value: undefined | Coding

        the tag value

      Returns this

      this

    • Returns boolean

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

    • Returns string

      the FHIR type defined in the FHIR standard

    • Returns boolean

      true if the instance is empty; false otherwise

    • Creates a copy of the current instance.

      Returns Meta

      the a new instance copied from the current instance

    • Returns boolean

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

    • Returns string

      the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)

    • Returns undefined | Value

      the JSON value or undefined if the instance is empty

    • 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 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 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

    • Protected

      Copies the current instance's elements into the provided object.

      Parameters

      • dest: Meta

        the copied instance

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods