observations

Create Observation

post
/organizations/{organizationId}/fhir/3/Observation

Measurements and simple assertions made about a patient, device or other subject.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringObservationThis is a Observation resource
identifierarray(Identifier)A unique identifier assigned to this observation.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
statusstringregistered|preliminary|final|amended|corrected|cancelled|entered-in-error|unknownThe status of the result value.
categoryarray(CodeableConcept)A code that classifies the general type of observation being made.
code*CodeableConceptDescribes what was observed. Sometimes this is called the observation "name".
subjectReferenceThe patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTimestringThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
effectivePeriodPeriodThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
issuedstringThe date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performerarray(Reference)Who was responsible for asserting the observed value as "true".
valueQuantityQuantityThe information determined as a result of making the observation, if the information has a simple value.
valueCodeableConceptCodeableConceptThe information determined as a result of making the observation, if the information has a simple value.
valueStringstringThe information determined as a result of making the observation, if the information has a simple value.
valueBooleanbooleanThe information determined as a result of making the observation, if the information has a simple value.
valueRangeRangeThe information determined as a result of making the observation, if the information has a simple value.
valueRatioRatioThe information determined as a result of making the observation, if the information has a simple value.
valueSampledDataSampledDataThe information determined as a result of making the observation, if the information has a simple value.
valueAttachmentAttachmentThe information determined as a result of making the observation, if the information has a simple value.
valueTimestringThe information determined as a result of making the observation, if the information has a simple value.
valueDateTimestringThe information determined as a result of making the observation, if the information has a simple value.
valuePeriodPeriodThe information determined as a result of making the observation, if the information has a simple value.
dataAbsentReasonCodeableConceptProvides a reason why the expected value in the element Observation.value[x] is missing.
interpretationCodeableConceptThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
commentstringMay include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
bodySiteCodeableConceptIndicates the site on the subject's body where the observation was made (i.e. the target site).
methodCodeableConceptIndicates the mechanism used to perform the observation.
specimenReferenceThe specimen that was used when this observation was made.
deviceReferenceThe device used to generate the observation data.
referenceRangearray(Observation_ReferenceRange)Guidance on how to interpret the value by comparison to a normal or recommended range.
relatedarray(Observation_Related)A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
componentarray(Observation_Component)Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

Response

Patch Observation

patch
/organizations/{organizationId}/fhir/3/Observation/{resourceId}

Measurements and simple assertions made about a patient, device or other subject.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringObservationThis is a Observation resource
identifierarray(Identifier)A unique identifier assigned to this observation.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
statusstringregistered|preliminary|final|amended|corrected|cancelled|entered-in-error|unknownThe status of the result value.
categoryarray(CodeableConcept)A code that classifies the general type of observation being made.
code*CodeableConceptDescribes what was observed. Sometimes this is called the observation "name".
subjectReferenceThe patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTimestringThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
effectivePeriodPeriodThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
issuedstringThe date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performerarray(Reference)Who was responsible for asserting the observed value as "true".
valueQuantityQuantityThe information determined as a result of making the observation, if the information has a simple value.
valueCodeableConceptCodeableConceptThe information determined as a result of making the observation, if the information has a simple value.
valueStringstringThe information determined as a result of making the observation, if the information has a simple value.
valueBooleanbooleanThe information determined as a result of making the observation, if the information has a simple value.
valueRangeRangeThe information determined as a result of making the observation, if the information has a simple value.
valueRatioRatioThe information determined as a result of making the observation, if the information has a simple value.
valueSampledDataSampledDataThe information determined as a result of making the observation, if the information has a simple value.
valueAttachmentAttachmentThe information determined as a result of making the observation, if the information has a simple value.
valueTimestringThe information determined as a result of making the observation, if the information has a simple value.
valueDateTimestringThe information determined as a result of making the observation, if the information has a simple value.
valuePeriodPeriodThe information determined as a result of making the observation, if the information has a simple value.
dataAbsentReasonCodeableConceptProvides a reason why the expected value in the element Observation.value[x] is missing.
interpretationCodeableConceptThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
commentstringMay include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
bodySiteCodeableConceptIndicates the site on the subject's body where the observation was made (i.e. the target site).
methodCodeableConceptIndicates the mechanism used to perform the observation.
specimenReferenceThe specimen that was used when this observation was made.
deviceReferenceThe device used to generate the observation data.
referenceRangearray(Observation_ReferenceRange)Guidance on how to interpret the value by comparison to a normal or recommended range.
relatedarray(Observation_Related)A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
componentarray(Observation_Component)Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

Response

Read Observation

get
/organizations/{organizationId}/fhir/3/Observation/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Observation

get
/organizations/{organizationId}/fhir/3/Observation/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Observation

get
/organizations/{organizationId}/fhir/3/Observation/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Observation

delete
/organizations/{organizationId}/fhir/3/Observation/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Observation

get
/organizations/{organizationId}/fhir/3/Observation

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
based-onstring
categorystring
codestring
code-value-conceptstring
code-value-datestring
code-value-quantitystring
code-value-stringstring
combo-codestring
combo-code-value-conceptstring
combo-code-value-quantitystring
combo-data-absent-reasonstring
combo-value-conceptstring
combo-value-quantitystring
component-codestring
component-code-value-conceptstring
component-code-value-quantitystring
component-data-absent-reasonstring
component-value-conceptstring
component-value-quantitystring
contextstring
data-absent-reasonstring
datestring
devicestring
encounterstring
identifierstring
methodstring
patientstring
performerstring
relatedstring
related-targetstring
related-typestring
specimenstring
statusstring
subjectstring
value-conceptstring
value-datestring
value-quantitystring
value-stringstring

Params

organizationId*string|stringid|slug

Response

Search History Observation

get
/organizations/{organizationId}/fhir/3/Observation/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Observation

post
/organizations/{organizationId}/fhir/3/Observation/_search

Measurements and simple assertions made about a patient, device or other subject.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
based-onstring
categorystring
codestring
code-value-conceptstring
code-value-datestring
code-value-quantitystring
code-value-stringstring
combo-codestring
combo-code-value-conceptstring
combo-code-value-quantitystring
combo-data-absent-reasonstring
combo-value-conceptstring
combo-value-quantitystring
component-codestring
component-code-value-conceptstring
component-code-value-quantitystring
component-data-absent-reasonstring
component-value-conceptstring
component-value-quantitystring
contextstring
data-absent-reasonstring
datestring
devicestring
encounterstring
identifierstring
methodstring
patientstring
performerstring
relatedstring
related-targetstring
related-typestring
specimenstring
statusstring
subjectstring
value-conceptstring
value-datestring
value-quantitystring
value-stringstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringObservationThis is a Observation resource
identifierarray(Identifier)A unique identifier assigned to this observation.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
statusstringregistered|preliminary|final|amended|corrected|cancelled|entered-in-error|unknownThe status of the result value.
categoryarray(CodeableConcept)A code that classifies the general type of observation being made.
code*CodeableConceptDescribes what was observed. Sometimes this is called the observation "name".
subjectReferenceThe patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTimestringThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
effectivePeriodPeriodThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
issuedstringThe date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performerarray(Reference)Who was responsible for asserting the observed value as "true".
valueQuantityQuantityThe information determined as a result of making the observation, if the information has a simple value.
valueCodeableConceptCodeableConceptThe information determined as a result of making the observation, if the information has a simple value.
valueStringstringThe information determined as a result of making the observation, if the information has a simple value.
valueBooleanbooleanThe information determined as a result of making the observation, if the information has a simple value.
valueRangeRangeThe information determined as a result of making the observation, if the information has a simple value.
valueRatioRatioThe information determined as a result of making the observation, if the information has a simple value.
valueSampledDataSampledDataThe information determined as a result of making the observation, if the information has a simple value.
valueAttachmentAttachmentThe information determined as a result of making the observation, if the information has a simple value.
valueTimestringThe information determined as a result of making the observation, if the information has a simple value.
valueDateTimestringThe information determined as a result of making the observation, if the information has a simple value.
valuePeriodPeriodThe information determined as a result of making the observation, if the information has a simple value.
dataAbsentReasonCodeableConceptProvides a reason why the expected value in the element Observation.value[x] is missing.
interpretationCodeableConceptThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
commentstringMay include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
bodySiteCodeableConceptIndicates the site on the subject's body where the observation was made (i.e. the target site).
methodCodeableConceptIndicates the mechanism used to perform the observation.
specimenReferenceThe specimen that was used when this observation was made.
deviceReferenceThe device used to generate the observation data.
referenceRangearray(Observation_ReferenceRange)Guidance on how to interpret the value by comparison to a normal or recommended range.
relatedarray(Observation_Related)A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
componentarray(Observation_Component)Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

Response

Update Observation

put
/organizations/{organizationId}/fhir/3/Observation/{resourceId}

Measurements and simple assertions made about a patient, device or other subject.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringObservationThis is a Observation resource
identifierarray(Identifier)A unique identifier assigned to this observation.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
statusstringregistered|preliminary|final|amended|corrected|cancelled|entered-in-error|unknownThe status of the result value.
categoryarray(CodeableConcept)A code that classifies the general type of observation being made.
code*CodeableConceptDescribes what was observed. Sometimes this is called the observation "name".
subjectReferenceThe patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTimestringThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
effectivePeriodPeriodThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
issuedstringThe date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performerarray(Reference)Who was responsible for asserting the observed value as "true".
valueQuantityQuantityThe information determined as a result of making the observation, if the information has a simple value.
valueCodeableConceptCodeableConceptThe information determined as a result of making the observation, if the information has a simple value.
valueStringstringThe information determined as a result of making the observation, if the information has a simple value.
valueBooleanbooleanThe information determined as a result of making the observation, if the information has a simple value.
valueRangeRangeThe information determined as a result of making the observation, if the information has a simple value.
valueRatioRatioThe information determined as a result of making the observation, if the information has a simple value.
valueSampledDataSampledDataThe information determined as a result of making the observation, if the information has a simple value.
valueAttachmentAttachmentThe information determined as a result of making the observation, if the information has a simple value.
valueTimestringThe information determined as a result of making the observation, if the information has a simple value.
valueDateTimestringThe information determined as a result of making the observation, if the information has a simple value.
valuePeriodPeriodThe information determined as a result of making the observation, if the information has a simple value.
dataAbsentReasonCodeableConceptProvides a reason why the expected value in the element Observation.value[x] is missing.
interpretationCodeableConceptThe assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
commentstringMay include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
bodySiteCodeableConceptIndicates the site on the subject's body where the observation was made (i.e. the target site).
methodCodeableConceptIndicates the mechanism used to perform the observation.
specimenReferenceThe specimen that was used when this observation was made.
deviceReferenceThe device used to generate the observation data.
referenceRangearray(Observation_ReferenceRange)Guidance on how to interpret the value by comparison to a normal or recommended range.
relatedarray(Observation_Related)A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
componentarray(Observation_Component)Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

Response