Private OptionalauthorAnnotation.author[x] Element
FHIR Specification
Private OptionaltimeAnnotation.time Element
PrivatetextAnnotation.text Element
StaticparseParse the provided Annotation JSON to instantiate the Annotation data model.
JSON representing FHIR Annotation
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Annotation
Annotation data model or undefined for Annotation
JsonError if the provided JSON is not a valid JSON object
the author property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the author property.
the author object value
this
InvalidTypeError for invalid data types
true if the author property exists and has a value; false otherwise
the author property value as a Reference object if defined; else undefined
true if the author property exists as a Reference and has a value; false otherwise
the author property value as a StringType object if defined; else undefined
true if the author property exists as a StringType and has a value; false otherwise
the time property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the time property.
the time value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the time property exists and has a value; false otherwise
the time property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the time property.
the time value
this
PrimitiveTypeError for invalid primitive types
true if the time property exists and has a value; false otherwise
the text property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the text property.
the text value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the text property exists and has a value; false otherwise
the text property value as a fhirMarkdown if defined; else null
Assigns the provided primitive value to the text property.
the text value
this
PrimitiveTypeError for invalid primitive types
true if the text property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
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
Creates a copy of the current instance.
the a new instance copied from the current instance
true if the instance is a FHIR complex datatype; false otherwise
the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)
the JSON value or undefined if the instance is empty
true if the instance is a FHIR complex or primitive datatype; false otherwise
the id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
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.
the url that identifies a specific Extension
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.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
Annotation Class
Remarks
Annotation Type: A text note which also contains information about who made the statement and when.
FHIR Specification
See
FHIR Annotation