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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Observation	This is a Observation resource
identifier	array(Identifier)		A unique identifier assigned to this observation.
basedOn	array(Reference)		A plan, proposal or order that is fulfilled in whole or in part by this event.
status	string	registered\|preliminary\|final\|amended\|corrected\|cancelled\|entered-in-error\|unknown	The status of the result value.
category	array(CodeableConcept)		A code that classifies the general type of observation being made.
code*	CodeableConcept		Describes what was observed. Sometimes this is called the observation "name".
subject	Reference		The 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.
context	Reference		The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTime	string		The 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.
effectivePeriod	Period		The 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.
issued	string		The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performer	array(Reference)		Who was responsible for asserting the observed value as "true".
valueQuantity	Quantity		The information determined as a result of making the observation, if the information has a simple value.
valueCodeableConcept	CodeableConcept		The information determined as a result of making the observation, if the information has a simple value.
valueString	string		The information determined as a result of making the observation, if the information has a simple value.
valueBoolean	boolean		The information determined as a result of making the observation, if the information has a simple value.
valueRange	Range		The information determined as a result of making the observation, if the information has a simple value.
valueRatio	Ratio		The information determined as a result of making the observation, if the information has a simple value.
valueSampledData	SampledData		The information determined as a result of making the observation, if the information has a simple value.
valueAttachment	Attachment		The information determined as a result of making the observation, if the information has a simple value.
valueTime	string		The information determined as a result of making the observation, if the information has a simple value.
valueDateTime	string		The information determined as a result of making the observation, if the information has a simple value.
valuePeriod	Period		The information determined as a result of making the observation, if the information has a simple value.
dataAbsentReason	CodeableConcept		Provides a reason why the expected value in the element Observation.value[x] is missing.
interpretation	CodeableConcept		The 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.
comment	string		May 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.
bodySite	CodeableConcept		Indicates the site on the subject's body where the observation was made (i.e. the target site).
method	CodeableConcept		Indicates the mechanism used to perform the observation.
specimen	Reference		The specimen that was used when this observation was made.
device	Reference		The device used to generate the observation data.
referenceRange	array(Observation_ReferenceRange)		Guidance on how to interpret the value by comparison to a normal or recommended range.
related	array(Observation_Related)		A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
component	array(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

201 400 401 404

Patch Observation

patch

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

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Observation	This is a Observation resource
identifier	array(Identifier)		A unique identifier assigned to this observation.
basedOn	array(Reference)		A plan, proposal or order that is fulfilled in whole or in part by this event.
status	string	registered\|preliminary\|final\|amended\|corrected\|cancelled\|entered-in-error\|unknown	The status of the result value.
category	array(CodeableConcept)		A code that classifies the general type of observation being made.
code*	CodeableConcept		Describes what was observed. Sometimes this is called the observation "name".
subject	Reference		The 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.
context	Reference		The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTime	string		The 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.
effectivePeriod	Period		The 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.
issued	string		The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performer	array(Reference)		Who was responsible for asserting the observed value as "true".
valueQuantity	Quantity		The information determined as a result of making the observation, if the information has a simple value.
valueCodeableConcept	CodeableConcept		The information determined as a result of making the observation, if the information has a simple value.
valueString	string		The information determined as a result of making the observation, if the information has a simple value.
valueBoolean	boolean		The information determined as a result of making the observation, if the information has a simple value.
valueRange	Range		The information determined as a result of making the observation, if the information has a simple value.
valueRatio	Ratio		The information determined as a result of making the observation, if the information has a simple value.
valueSampledData	SampledData		The information determined as a result of making the observation, if the information has a simple value.
valueAttachment	Attachment		The information determined as a result of making the observation, if the information has a simple value.
valueTime	string		The information determined as a result of making the observation, if the information has a simple value.
valueDateTime	string		The information determined as a result of making the observation, if the information has a simple value.
valuePeriod	Period		The information determined as a result of making the observation, if the information has a simple value.
dataAbsentReason	CodeableConcept		Provides a reason why the expected value in the element Observation.value[x] is missing.
interpretation	CodeableConcept		The 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.
comment	string		May 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.
bodySite	CodeableConcept		Indicates the site on the subject's body where the observation was made (i.e. the target site).
method	CodeableConcept		Indicates the mechanism used to perform the observation.
specimen	Reference		The specimen that was used when this observation was made.
device	Reference		The device used to generate the observation data.
referenceRange	array(Observation_ReferenceRange)		Guidance on how to interpret the value by comparison to a normal or recommended range.
related	array(Observation_Related)		A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
component	array(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

200 201 400 401 404 409

Read Observation

get

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Observation

get

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Observation

get

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Observation

delete

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Observation

get

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
based-on	string
category	string
code	string
code-value-concept	string
code-value-date	string
code-value-quantity	string
code-value-string	string
combo-code	string
combo-code-value-concept	string
combo-code-value-quantity	string
combo-data-absent-reason	string
combo-value-concept	string
combo-value-quantity	string
component-code	string
component-code-value-concept	string
component-code-value-quantity	string
component-data-absent-reason	string
component-value-concept	string
component-value-quantity	string
context	string
data-absent-reason	string
date	string
device	string
encounter	string
identifier	string
method	string
patient	string
performer	string
related	string
related-target	string
related-type	string
specimen	string
status	string
subject	string
value-concept	string
value-date	string
value-quantity	string
value-string	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Observation

get

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Observation

post

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

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
based-on	string
category	string
code	string
code-value-concept	string
code-value-date	string
code-value-quantity	string
code-value-string	string
combo-code	string
combo-code-value-concept	string
combo-code-value-quantity	string
combo-data-absent-reason	string
combo-value-concept	string
combo-value-quantity	string
component-code	string
component-code-value-concept	string
component-code-value-quantity	string
component-data-absent-reason	string
component-value-concept	string
component-value-quantity	string
context	string
data-absent-reason	string
date	string
device	string
encounter	string
identifier	string
method	string
patient	string
performer	string
related	string
related-target	string
related-type	string
specimen	string
status	string
subject	string
value-concept	string
value-date	string
value-quantity	string
value-string	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Observation	This is a Observation resource
identifier	array(Identifier)		A unique identifier assigned to this observation.
basedOn	array(Reference)		A plan, proposal or order that is fulfilled in whole or in part by this event.
status	string	registered\|preliminary\|final\|amended\|corrected\|cancelled\|entered-in-error\|unknown	The status of the result value.
category	array(CodeableConcept)		A code that classifies the general type of observation being made.
code*	CodeableConcept		Describes what was observed. Sometimes this is called the observation "name".
subject	Reference		The 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.
context	Reference		The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTime	string		The 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.
effectivePeriod	Period		The 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.
issued	string		The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performer	array(Reference)		Who was responsible for asserting the observed value as "true".
valueQuantity	Quantity		The information determined as a result of making the observation, if the information has a simple value.
valueCodeableConcept	CodeableConcept		The information determined as a result of making the observation, if the information has a simple value.
valueString	string		The information determined as a result of making the observation, if the information has a simple value.
valueBoolean	boolean		The information determined as a result of making the observation, if the information has a simple value.
valueRange	Range		The information determined as a result of making the observation, if the information has a simple value.
valueRatio	Ratio		The information determined as a result of making the observation, if the information has a simple value.
valueSampledData	SampledData		The information determined as a result of making the observation, if the information has a simple value.
valueAttachment	Attachment		The information determined as a result of making the observation, if the information has a simple value.
valueTime	string		The information determined as a result of making the observation, if the information has a simple value.
valueDateTime	string		The information determined as a result of making the observation, if the information has a simple value.
valuePeriod	Period		The information determined as a result of making the observation, if the information has a simple value.
dataAbsentReason	CodeableConcept		Provides a reason why the expected value in the element Observation.value[x] is missing.
interpretation	CodeableConcept		The 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.
comment	string		May 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.
bodySite	CodeableConcept		Indicates the site on the subject's body where the observation was made (i.e. the target site).
method	CodeableConcept		Indicates the mechanism used to perform the observation.
specimen	Reference		The specimen that was used when this observation was made.
device	Reference		The device used to generate the observation data.
referenceRange	array(Observation_ReferenceRange)		Guidance on how to interpret the value by comparison to a normal or recommended range.
related	array(Observation_Related)		A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
component	array(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

200 401 404

Update Observation

put

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

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

Nictiz profile: Observation

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Observation	This is a Observation resource
identifier	array(Identifier)		A unique identifier assigned to this observation.
basedOn	array(Reference)		A plan, proposal or order that is fulfilled in whole or in part by this event.
status	string	registered\|preliminary\|final\|amended\|corrected\|cancelled\|entered-in-error\|unknown	The status of the result value.
category	array(CodeableConcept)		A code that classifies the general type of observation being made.
code*	CodeableConcept		Describes what was observed. Sometimes this is called the observation "name".
subject	Reference		The 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.
context	Reference		The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
effectiveDateTime	string		The 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.
effectivePeriod	Period		The 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.
issued	string		The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
performer	array(Reference)		Who was responsible for asserting the observed value as "true".
valueQuantity	Quantity		The information determined as a result of making the observation, if the information has a simple value.
valueCodeableConcept	CodeableConcept		The information determined as a result of making the observation, if the information has a simple value.
valueString	string		The information determined as a result of making the observation, if the information has a simple value.
valueBoolean	boolean		The information determined as a result of making the observation, if the information has a simple value.
valueRange	Range		The information determined as a result of making the observation, if the information has a simple value.
valueRatio	Ratio		The information determined as a result of making the observation, if the information has a simple value.
valueSampledData	SampledData		The information determined as a result of making the observation, if the information has a simple value.
valueAttachment	Attachment		The information determined as a result of making the observation, if the information has a simple value.
valueTime	string		The information determined as a result of making the observation, if the information has a simple value.
valueDateTime	string		The information determined as a result of making the observation, if the information has a simple value.
valuePeriod	Period		The information determined as a result of making the observation, if the information has a simple value.
dataAbsentReason	CodeableConcept		Provides a reason why the expected value in the element Observation.value[x] is missing.
interpretation	CodeableConcept		The 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.
comment	string		May 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.
bodySite	CodeableConcept		Indicates the site on the subject's body where the observation was made (i.e. the target site).
method	CodeableConcept		Indicates the mechanism used to perform the observation.
specimen	Reference		The specimen that was used when this observation was made.
device	Reference		The device used to generate the observation data.
referenceRange	array(Observation_ReferenceRange)		Guidance on how to interpret the value by comparison to a normal or recommended range.
related	array(Observation_Related)		A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
component	array(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

200 201 400 401 404 409