observations

Create Observation

post

/organizations/{organizationId}/fhir/4/Observation

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

Request

Headers


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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a Observation resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
partOf	array(Reference)		A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
status		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 this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.
focus	array(Reference)		The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
encounter	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.
effectiveTiming	Timing		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.
effectiveInstant	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.
issued	instant		The date and time this version of the 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.
valueInteger	number		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.
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	array(CodeableConcept)		A categorical assessment of an observation value. For example, high, low, normal.
note	array(Annotation)		Comments about the observation or the results.
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. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
hasMember	array(Reference)		This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
derivedFrom	array(Reference)		The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
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/4/Observation/{resourceId}

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

Nictiz profile: Observation

Request

Headers

Params


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

Body


resourceType*			This is a Observation resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
partOf	array(Reference)		A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
status		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 this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.
focus	array(Reference)		The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
encounter	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.
effectiveTiming	Timing		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.
effectiveInstant	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.
issued	instant		The date and time this version of the 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.
valueInteger	number		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.
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	array(CodeableConcept)		A categorical assessment of an observation value. For example, high, low, normal.
note	array(Annotation)		Comments about the observation or the results.
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. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
hasMember	array(Reference)		This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
derivedFrom	array(Reference)		The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
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/4/Observation/{resourceId}

Nictiz profile: Observation

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/Observation/{resourceId}/_history

Nictiz profile: Observation

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/Observation/{resourceId}/_history/{versionId}

Nictiz profile: Observation

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/Observation/{resourceId}

Nictiz profile: Observation

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/Observation

Nictiz profile: Observation

Request

Headers


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

Query params


_id	string
_language	string
_count	string
_include	string
_revinclude	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
data-absent-reason	string
date
derived-from	string
device	string
encounter	string
focus	string
has-member	string
identifier	string
method	string
part-of	string
patient	string
performer	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/4/Observation/_history

Nictiz profile: Observation

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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/4/Observation/_search

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

Nictiz profile: Observation

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml\|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
data-absent-reason	string
date
derived-from	string
device	string
encounter	string
focus	string
has-member	string
identifier	string
method	string
part-of	string
patient	string
performer	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*			This is a Observation resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
partOf	array(Reference)		A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
status		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 this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.
focus	array(Reference)		The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
encounter	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.
effectiveTiming	Timing		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.
effectiveInstant	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.
issued	instant		The date and time this version of the 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.
valueInteger	number		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.
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	array(CodeableConcept)		A categorical assessment of an observation value. For example, high, low, normal.
note	array(Annotation)		Comments about the observation or the results.
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. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
hasMember	array(Reference)		This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
derivedFrom	array(Reference)		The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
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/4/Observation/{resourceId}

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

Nictiz profile: Observation

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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*			This is a Observation resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
partOf	array(Reference)		A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
status		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 this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.
focus	array(Reference)		The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
encounter	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.
effectiveTiming	Timing		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.
effectiveInstant	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.
issued	instant		The date and time this version of the 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.
valueInteger	number		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.
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	array(CodeableConcept)		A categorical assessment of an observation value. For example, high, low, normal.
note	array(Annotation)		Comments about the observation or the results.
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. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
hasMember	array(Reference)		This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
derivedFrom	array(Reference)		The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
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