Private OptionalidentifierObservation.identifier Element
Private OptionalbasedObservation.basedOn Element
FHIR Specification
Reference
Private OptionalpartObservation.partOf Element
FHIR Specification
encounter. See the Notes below for guidance on referencing another Observation.Reference
Private ReadonlyobservationFHIR CodeSystem: ObservationStatus
PrivatestatusObservation.status Element
FHIR Specification
codeCodeSystem Enumeration: ObservationStatusEnum
Private OptionalcategoryObservation.category Element
FHIR Specification
CodeableConceptPrivatecodeObservation.code Element
FHIR Specification
CodeableConceptPrivate OptionalsubjectObservation.subject Element
FHIR Specification
focus element or the code itself specifies the actual focus of the observation.Reference
Private OptionalfocusObservation.focus Element
FHIR Specification
specimen if a reference to a specimen is required. If a code is required instead of a resource use either bodysite for bodysites or the standard extension focusCode.Reference
Private OptionalencounterObservation.encounter Element
FHIR Specification
Reference
Private OptionaleffectiveObservation.effective[x] Element
FHIR Specification
Private OptionalissuedObservation.issued Element
FHIR Specification
lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that doesn't require the new version to be reviewed and verified again.instantPrivate OptionalperformerObservation.performer Element
FHIR Specification
Reference
Private OptionalvalueObservation.value[x] Element
@ChoiceDataTypesMeta('Observation.value[x]', ['Quantity','CodeableConcept','string','boolean','integer','Range','Ratio','SampledData','time','dateTime','Period',]
FHIR Specification
Private OptionaldataObservation.dataAbsentReason Element
FHIR Specification
CodeableConceptPrivate OptionalinterpretationObservation.interpretation Element
FHIR Specification
CodeableConceptPrivate OptionalnoteObservation.note Element
FHIR Specification
AnnotationPrivate OptionalbodyObservation.bodySite Element
FHIR Specification
CodeableConceptPrivate OptionalmethodObservation.method Element
FHIR Specification
CodeableConceptPrivate OptionalspecimenObservation.specimen Element
FHIR Specification
Observation.code. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).Reference
Private OptionaldeviceObservation.device Element
FHIR Specification
Reference
Private OptionalreferenceObservation.referenceRange Element
FHIR Specification
referenceRange elements would be used.BackboneElementPrivate OptionalhasObservation.hasMember Element
FHIR Specification
Reference
Private OptionalderivedObservation.derivedFrom Element
FHIR Specification
Reference
Private OptionalcomponentObservation.component Element
FHIR Specification
BackboneElementStaticparseParse the provided Observation JSON to instantiate the Observation data model.
JSON representing FHIR Observation
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Observation
Observation data model or undefined for Observation
JsonError if the provided JSON is not a valid JSON object
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 basedOn property value as a Reference array
Assigns the provided Reference array value to the basedOn property.
the basedOn array value
this
@ReferenceTargets('Observation.basedOn', ['CarePlan','DeviceRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','ServiceRequest',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the basedOn array property.
the basedOn value
this
@ReferenceTargets('Observation.basedOn', ['CarePlan','DeviceRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','ServiceRequest',])
InvalidTypeError for invalid data type or reference value
true if the basedOn property exists and has a value; false otherwise
the partOf property value as a Reference array
Assigns the provided Reference array value to the partOf property.
the partOf array value
this
@ReferenceTargets('Observation.partOf', ['MedicationAdministration','MedicationDispense','MedicationStatement','Procedure','Immunization','ImagingStudy',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the partOf array property.
the partOf value
this
@ReferenceTargets('Observation.partOf', ['MedicationAdministration','MedicationDispense','MedicationStatement','Procedure','Immunization','ImagingStudy',])
InvalidTypeError for invalid data type or reference value
true if the partOf property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: ObservationStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ObservationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: ObservationStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ObservationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: ObservationStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ObservationStatusEnum
true if the status property exists and has a value; false otherwise
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 subject property value as a Reference object; else an empty Reference object
Assigns the provided Subject object value to the subject property.
the subject object value
this
@ReferenceTargets('Observation.subject', ['Patient','Group','Device','Location','Organization','Procedure','Practitioner','Medication','Substance',])
InvalidTypeError for invalid data type or reference value
true if the subject property exists and has a value; false otherwise
the focus property value as a Reference array
Assigns the provided Reference array value to the focus property.
the focus array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the focus array property.
the focus value
this
InvalidTypeError for invalid data type or reference value
true if the focus property exists and has a value; false otherwise
the encounter property value as a Reference object; else an empty Reference object
Assigns the provided Encounter object value to the encounter property.
the encounter object value
this
InvalidTypeError for invalid data type or reference value
true if the encounter property exists and has a value; false otherwise
the effective property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the effective property.
the effective object value
this
InvalidTypeError for invalid data types
true if the effective property exists and has a value; false otherwise
the effective property value as a DateTimeType object if defined; else undefined
true if the effective property exists as a DateTimeType and has a value; false otherwise
the effective property value as a Period object if defined; else undefined
true if the effective property exists as a Period and has a value; false otherwise
the effective property value as a Timing object if defined; else undefined
true if the effective property exists as a Timing and has a value; false otherwise
the effective property value as a InstantType object if defined; else undefined
true if the effective property exists as a InstantType and has a value; false otherwise
the issued property value as a InstantType object if defined; else an empty InstantType object
Assigns the provided PrimitiveType value to the issued property.
the issued value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the issued property exists and has a value; false otherwise
the issued property value as a fhirInstant if defined; else undefined
Assigns the provided primitive value to the issued property.
the issued value
this
PrimitiveTypeError for invalid primitive types
true if the issued property exists and has a value; false otherwise
the performer property value as a Reference array
Assigns the provided Reference array value to the performer property.
the performer array value
this
@ReferenceTargets('Observation.performer', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the performer array property.
the performer value
this
@ReferenceTargets('Observation.performer', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the performer property exists and has a value; false otherwise
the value property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the value property.
the value object value
this
InvalidTypeError for invalid data types
true if the value property exists and has a value; false otherwise
the value property value as a Quantity object if defined; else undefined
true if the value property exists as a Quantity and has a value; false otherwise
the value property value as a CodeableConcept object if defined; else undefined
true if the value property exists as a CodeableConcept and has a value; false otherwise
the value property value as a StringType object if defined; else undefined
true if the value property exists as a StringType and has a value; false otherwise
the value property value as a BooleanType object if defined; else undefined
true if the value property exists as a BooleanType and has a value; false otherwise
the value property value as a IntegerType object if defined; else undefined
true if the value property exists as a IntegerType and has a value; false otherwise
the value property value as a Range object if defined; else undefined
true if the value property exists as a Range and has a value; false otherwise
the value property value as a Ratio object if defined; else undefined
true if the value property exists as a Ratio and has a value; false otherwise
the value property value as a SampledData object if defined; else undefined
true if the value property exists as a SampledData and has a value; false otherwise
the value property value as a TimeType object if defined; else undefined
true if the value property exists as a TimeType and has a value; false otherwise
the value property value as a DateTimeType object if defined; else undefined
true if the value property exists as a DateTimeType and has a value; false otherwise
the value property value as a Period object if defined; else undefined
true if the value property exists as a Period and has a value; false otherwise
the dataAbsentReason property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided DataAbsentReason object value to the dataAbsentReason property.
the dataAbsentReason object value
this
InvalidTypeError for invalid data types
true if the dataAbsentReason property exists and has a value; false otherwise
the interpretation property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the interpretation property.
the interpretation array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the interpretation array property.
the interpretation value
this
InvalidTypeError for invalid data types
true if the interpretation property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the bodySite property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided BodySite object value to the bodySite property.
the bodySite object value
this
InvalidTypeError for invalid data types
true if the bodySite 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 specimen property value as a Reference object; else an empty Reference object
Assigns the provided Specimen object value to the specimen property.
the specimen object value
this
InvalidTypeError for invalid data type or reference value
true if the specimen property exists and has a value; false otherwise
the device property value as a Reference object; else an empty Reference object
Assigns the provided Device object value to the device property.
the device object value
this
InvalidTypeError for invalid data type or reference value
true if the device property exists and has a value; false otherwise
the referenceRange property value as a ObservationReferenceRangeComponent array
Assigns the provided ObservationReferenceRangeComponent array value to the referenceRange property.
the referenceRange array value
this
InvalidTypeError for invalid data types
Add the provided ObservationReferenceRangeComponent value to the referenceRange array property.
the referenceRange value
this
InvalidTypeError for invalid data types
true if the referenceRange property exists and has a value; false otherwise
the hasMember property value as a Reference array
Assigns the provided Reference array value to the hasMember property.
the hasMember array value
this
@ReferenceTargets('Observation.hasMember', ['Observation','QuestionnaireResponse','MolecularSequence',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the hasMember array property.
the hasMember value
this
@ReferenceTargets('Observation.hasMember', ['Observation','QuestionnaireResponse','MolecularSequence',])
InvalidTypeError for invalid data type or reference value
true if the hasMember property exists and has a value; false otherwise
the derivedFrom property value as a Reference array
Assigns the provided Reference array value to the derivedFrom property.
the derivedFrom array value
this
@ReferenceTargets('Observation.derivedFrom', ['DocumentReference','ImagingStudy','Media','QuestionnaireResponse','Observation','MolecularSequence',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the derivedFrom array property.
the derivedFrom value
this
@ReferenceTargets('Observation.derivedFrom', ['DocumentReference','ImagingStudy','Media','QuestionnaireResponse','Observation','MolecularSequence',])
InvalidTypeError for invalid data type or reference value
true if the derivedFrom property exists and has a value; false otherwise
the component property value as a ObservationComponentComponent array
Assigns the provided ObservationComponentComponent array value to the component property.
the component array value
this
InvalidTypeError for invalid data types
Add the provided ObservationComponentComponent value to the component array property.
the component value
this
InvalidTypeError for invalid data types
true if the component 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 identifier property
PrivateinitInitialize the basedOn property
PrivateinitInitialize the partOf property
PrivateinitInitialize the category property
PrivateinitInitialize the focus property
PrivateinitInitialize the performer property
PrivateinitInitialize the interpretation property
PrivateinitInitialize the note property
PrivateinitInitialize the referenceRange property
PrivateinitInitialize the hasMember property
PrivateinitInitialize the derivedFrom property
PrivateinitInitialize the component property
Observation Class
Remarks
Measurements and simple assertions made about a patient, device or other subject.
Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.
FHIR Specification
See
FHIR Observation