Private OptionalcategoryObservationDefinition.category Element
FHIR Specification
CodeableConceptPrivatecodeObservationDefinition.code Element
FHIR Specification
CodeableConceptPrivate OptionalidentifierObservationDefinition.identifier Element
Private ReadonlypermittedFHIR CodeSystem: PermittedDataType
Private OptionalpermittedObservationDefinition.permittedDataType Element
FHIR Specification
codeCodeSystem Enumeration: PermittedDataTypeEnum
Private OptionalmultipleObservationDefinition.multipleResultsAllowed Element
FHIR Specification
booleanPrivate OptionalmethodObservationDefinition.method Element
FHIR Specification
CodeableConceptPrivate OptionalpreferredObservationDefinition.preferredReportName Element
Private OptionalquantitativeObservationDefinition.quantitativeDetails Element
Private OptionalqualifiedObservationDefinition.qualifiedInterval Element
FHIR Specification
BackboneElementPrivate OptionalvalidObservationDefinition.validCodedValueSet Element
FHIR Specification
Reference
Private OptionalnormalObservationDefinition.normalCodedValueSet Element
FHIR Specification
Reference
Private OptionalabnormalObservationDefinition.abnormalCodedValueSet Element
FHIR Specification
Reference
Private OptionalcriticalObservationDefinition.criticalCodedValueSet Element
FHIR Specification
Reference
StaticparseParse the provided ObservationDefinition JSON to instantiate the ObservationDefinition data model.
JSON representing FHIR ObservationDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ObservationDefinition
ObservationDefinition data model or undefined for ObservationDefinition
JsonError if the provided JSON is not a valid JSON object
the category property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the category property.
the category array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the category array property.
the category value
this
InvalidTypeError for invalid data types
true if the category property exists and has a value; false otherwise
the code property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept object value to the code property.
the code object value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the permittedDataType property value as a EnumCodeType array
CodeSystem Enumeration: PermittedDataTypeEnum
Assigns the provided EnumCodeType array value to the permittedDataType property.
the permittedDataType array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PermittedDataTypeEnum
Add the provided EnumCodeType value to the permittedDataType array property.
the permittedDataType value
this
InvalidCodeError for invalid code value
CodeSystem Enumeration: PermittedDataTypeEnum
true if the permittedDataType property exists and has a value; false otherwise
the permittedDataType property value as a CodeType array
CodeSystem Enumeration: PermittedDataTypeEnum
Assigns the provided PrimitiveType array value to the permittedDataType property.
the permittedDataType array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PermittedDataTypeEnum
Add the provided PrimitiveType value to the permittedDataType array property.
the permittedDataType value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PermittedDataTypeEnum
true if the permittedDataType property exists and has a value; false otherwise
the permittedDataType property value as a fhirCode array
CodeSystem Enumeration: PermittedDataTypeEnum
Assigns the provided primitive value array to the permittedDataType property.
the permittedDataType value array
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: PermittedDataTypeEnum
Add the provided primitive value to the permittedDataType array property.
the permittedDataType value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: PermittedDataTypeEnum
true if the permittedDataType property exists and has a value; false otherwise
the multipleResultsAllowed property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the multipleResultsAllowed property.
the multipleResultsAllowed value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the multipleResultsAllowed property exists and has a value; false otherwise
the multipleResultsAllowed property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the multipleResultsAllowed property.
the multipleResultsAllowed value
this
PrimitiveTypeError for invalid primitive types
true if the multipleResultsAllowed property exists and has a value; false otherwise
the method property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Method object value to the method property.
the method object value
this
InvalidTypeError for invalid data types
true if the method property exists and has a value; false otherwise
the preferredReportName property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the preferredReportName property.
the preferredReportName value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the preferredReportName property exists and has a value; false otherwise
the preferredReportName property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the preferredReportName property.
the preferredReportName value
this
PrimitiveTypeError for invalid primitive types
true if the preferredReportName property exists and has a value; false otherwise
the quantitativeDetails property value as a ObservationDefinitionQuantitativeDetailsComponent object if defined; else an empty ObservationDefinitionQuantitativeDetailsComponent object
Assigns the provided QuantitativeDetails object value to the quantitativeDetails property.
the quantitativeDetails object value
this
InvalidTypeError for invalid data types
true if the quantitativeDetails property exists and has a value; false otherwise
the qualifiedInterval property value as a ObservationDefinitionQualifiedIntervalComponent array
Assigns the provided ObservationDefinitionQualifiedIntervalComponent array value to the qualifiedInterval property.
the qualifiedInterval array value
this
InvalidTypeError for invalid data types
Add the provided ObservationDefinitionQualifiedIntervalComponent value to the qualifiedInterval array property.
the qualifiedInterval value
this
InvalidTypeError for invalid data types
true if the qualifiedInterval property exists and has a value; false otherwise
the validCodedValueSet property value as a Reference object; else an empty Reference object
Assigns the provided ValidCodedValueSet object value to the validCodedValueSet property.
the validCodedValueSet object value
this
InvalidTypeError for invalid data type or reference value
true if the validCodedValueSet property exists and has a value; false otherwise
the normalCodedValueSet property value as a Reference object; else an empty Reference object
Assigns the provided NormalCodedValueSet object value to the normalCodedValueSet property.
the normalCodedValueSet object value
this
InvalidTypeError for invalid data type or reference value
true if the normalCodedValueSet property exists and has a value; false otherwise
the abnormalCodedValueSet property value as a Reference object; else an empty Reference object
Assigns the provided AbnormalCodedValueSet object value to the abnormalCodedValueSet property.
the abnormalCodedValueSet object value
this
InvalidTypeError for invalid data type or reference value
true if the abnormalCodedValueSet property exists and has a value; false otherwise
the criticalCodedValueSet property value as a Reference object; else an empty Reference object
Assigns the provided CriticalCodedValueSet object value to the criticalCodedValueSet property.
the criticalCodedValueSet object value
this
InvalidTypeError for invalid data type or reference value
true if the criticalCodedValueSet 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
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property 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
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
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
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
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
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; 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
PrivateinitInitialize the category property
PrivateinitInitialize the identifier property
PrivateinitInitialize the permittedDataType property
PrivateinitInitialize the qualifiedInterval property
ObservationDefinition Class
Remarks
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
See
FHIR ObservationDefinition