Skip to main content
API docs by Redocly

Health NZ | Te Whatu Ora : API Standards FHIR Example Observation API (1.0.0)

Download OpenAPI specification:Download

URL: https://www.tewhatuora.govt.nz/ License: Creative Commons Zero v1.0 Universal

An example FHIR API for recording and consuming FHIR Observation data
Use cases include but are not limited to:
- Wearable input - e.g. smart watch recordings
- Vital signs measurements

FHIR Implementation Guide

searchObservations

Search Observation resources

Search all resources of type Observation based on a set of criteria

This base resource

Authorizations:
oauth-client-credentialsapi_key
query Parameters
date
string <date>
Example: date=2024-05-10

Search for Observations by date

patient
string
Example: patient=ZXP7823

Search for Observations by Patient

encounter
string
Example: encounter="545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0"

Search for Observations by an associated Encounter ID

identifier
string
Example: identifier="545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0"

Search for Observation resources by Observation.identifier

_count
number

The maximum number of search results on a page. The server is not bound to return the number requested, but cannot return more

category
string

The classification of the type of observation

performer
string

Who performed the observation

status
string

The status of the observation

subject
string

The subject that the observation is about

_lastUpdated
string([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9...

When the resource version last changed

header Parameters
object (Request-Context)

Request context header definition

Responses

Response samples

Content type
application/fhir+json
{}

getObservation

Retrieve an instance of an Observation resource

Read the current state of the resource

Retrieve an instance of an observation resource using the resource's unique id

Authorizations:
oauth-client-credentialsapi_key
path Parameters
rid
required
string
Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0"

id of the resource (=Resource.id)

query Parameters
_summary
string
Enum: "true" "text" "data" "count" "false"

Requests the server to return a designated subset of the resource

_elements
Array of any <string> [ items <string > ]

Requests the server to return a collection of elements from the resource

Responses

Response samples

Content type
application/fhir+json
{
  • "resourceType": "Observation",
  • "id": "string",
  • "meta": {
    },
  • "implicitRules": "string",
  • "_implicitRules": { },
  • "language": "string",
  • "_language": { },
  • "text": {
    },
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "basedOn": [
    ],
  • "partOf": [
    ],
  • "status": "registered",
  • "_status": { },
  • "category": [
    ],
  • "code": { },
  • "subject": { },
  • "focus": [
    ],
  • "encounter": { },
  • "effectiveDateTime": "string",
  • "_effectiveDateTime": { },
  • "effectivePeriod": { },
  • "effectiveTiming": { },
  • "effectiveInstant": "string",
  • "_effectiveInstant": { },
  • "issued": "string",
  • "_issued": { },
  • "performer": [
    ],
  • "valueQuantity": { },
  • "valueCodeableConcept": { },
  • "valueString": "string",
  • "_valueString": { },
  • "valueBoolean": true,
  • "_valueBoolean": { },
  • "valueInteger": 0,
  • "_valueInteger": { },
  • "valueRange": { },
  • "valueRatio": { },
  • "valueSampledData": { },
  • "valueTime": "string",
  • "_valueTime": { },
  • "valueDateTime": "string",
  • "_valueDateTime": { },
  • "valuePeriod": { },
  • "dataAbsentReason": { },
  • "interpretation": [
    ],
  • "note": [
    ],
  • "bodySite": { },
  • "method": { },
  • "specimen": { },
  • "device": { },
  • "referenceRange": [
    ],
  • "hasMember": [
    ],
  • "derivedFrom": [
    ],
  • "component": [
    ]
}

vreadObservation

Retrieve a specific version of an Observation resource

Read a past state of the resource

Read the past state of a resource using the resource's unique id and a specific version

Authorizations:
oauth-client-credentialsapi_key
path Parameters
rid
required
string
Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0"

id of the resource (=Resource.id)

hid
required
string <uuid>
Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0"

id of the history entry (=Resource.meta.versionId)

query Parameters
_summary
string
Enum: "true" "text" "data" "count" "false"

Requests the server to return a designated subset of the resource

_elements
Array of any <string> [ items <string > ]

Requests the server to return a collection of elements from the resource

Responses

Response samples

Content type
application/fhir+json
{
  • "resourceType": "Observation",
  • "id": "string",
  • "meta": {
    },
  • "implicitRules": "string",
  • "_implicitRules": { },
  • "language": "string",
  • "_language": { },
  • "text": {
    },
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "basedOn": [
    ],
  • "partOf": [
    ],
  • "status": "registered",
  • "_status": { },
  • "category": [
    ],
  • "code": { },
  • "subject": { },
  • "focus": [
    ],
  • "encounter": { },
  • "effectiveDateTime": "string",
  • "_effectiveDateTime": { },
  • "effectivePeriod": { },
  • "effectiveTiming": { },
  • "effectiveInstant": "string",
  • "_effectiveInstant": { },
  • "issued": "string",
  • "_issued": { },
  • "performer": [
    ],
  • "valueQuantity": { },
  • "valueCodeableConcept": { },
  • "valueString": "string",
  • "_valueString": { },
  • "valueBoolean": true,
  • "_valueBoolean": { },
  • "valueInteger": 0,
  • "_valueInteger": { },
  • "valueRange": { },
  • "valueRatio": { },
  • "valueSampledData": { },
  • "valueTime": "string",
  • "_valueTime": { },
  • "valueDateTime": "string",
  • "_valueDateTime": { },
  • "valuePeriod": { },
  • "dataAbsentReason": { },
  • "interpretation": [
    ],
  • "note": [
    ],
  • "bodySite": { },
  • "method": { },
  • "specimen": { },
  • "device": { },
  • "referenceRange": [
    ],
  • "hasMember": [
    ],
  • "derivedFrom": [
    ],
  • "component": [
    ]
}

createObservation

Create Observation resource

Create a new resource

Create a new Observation resource

Authorizations:
oauth-client-credentialsapi_key
query Parameters
_summary
string
Enum: "true" "text" "data" "count" "false"

Requests the server to return a designated subset of the resource

_elements
Array of any <string> [ items <string > ]

Requests the server to return a collection of elements from the resource

header Parameters
object (Request-Context)

Request context header definition

Request Body schema: application/fhir+json
required

The new state of the resource

resourceType
required
any
Value: "Observation"

This is a Observation resource

id
string^[A-Za-z0-9\-\.]{1,64}$

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

object

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
string^\S*$

String of characters used to identify a name or a resource

object

Base definition for all elements in a resource.

language
string^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

object

Base definition for all elements in a resource.

object

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.

extension
Array of any

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 of any

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).

Array of objects

A unique identifier assigned to this observation.

Array of objects

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 of any

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

status
any
Enum: "registered" "preliminary" "final" "amended" "corrected" "cancelled" "entered-in-error" "unknown"

The status of the result value.

object

Base definition for all elements in a resource.

category
Array of any

A code that classifies the general type of observation being made.

required
object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

object

A reference from one resource to another.

focus
Array of any

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.

object

A reference from one resource to another.

effectiveDateTime
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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.

object

Base definition for all elements in a resource.

object

A time period defined by a start and end date and optionally time.

object

Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

effectiveInstant
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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.

object

Base definition for all elements in a resource.

issued
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

object

Base definition for all elements in a resource.

performer
Array of any

Who was responsible for asserting the observed value as "true".

object

A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

valueString
string^[ \r\n\t\S]+$

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

valueBoolean
boolean^true|false$

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

valueInteger
number^-?([0]|([1-9][0-9]*))$

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

object

The information determined as a result of making the observation, if the information has a simple value.

object

The information determined as a result of making the observation, if the information has a simple value.

object

The information determined as a result of making the observation, if the information has a simple value.

valueTime
string^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60...

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

valueDateTime
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

object

A time period defined by a start and end date and optionally time.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

interpretation
Array of any

A categorical assessment of an observation value. For example, high, low, normal.

Array of objects

Comments about the observation or the results.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

object

A reference from one resource to another.

object

A reference from one resource to another.

Array of objects

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 of any

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 of any

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.

Array of objects

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.

Responses

Request samples

Content type
application/fhir+json
{
  • "resourceType": "Observation",
  • "id": "string",
  • "meta": {
    },
  • "implicitRules": "string",
  • "_implicitRules": { },
  • "language": "string",
  • "_language": { },
  • "text": {
    },
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "basedOn": [
    ],
  • "partOf": [
    ],
  • "status": "registered",
  • "_status": { },
  • "category": [
    ],
  • "code": { },
  • "subject": { },
  • "focus": [
    ],
  • "encounter": { },
  • "effectiveDateTime": "string",
  • "_effectiveDateTime": { },
  • "effectivePeriod": { },
  • "effectiveTiming": { },
  • "effectiveInstant": "string",
  • "_effectiveInstant": { },
  • "issued": "string",
  • "_issued": { },
  • "performer": [
    ],
  • "valueQuantity": { },
  • "valueCodeableConcept": { },
  • "valueString": "string",
  • "_valueString": { },
  • "valueBoolean": true,
  • "_valueBoolean": { },
  • "valueInteger": 0,
  • "_valueInteger": { },
  • "valueRange": { },
  • "valueRatio": { },
  • "valueSampledData": { },
  • "valueTime": "string",
  • "_valueTime": { },
  • "valueDateTime": "string",
  • "_valueDateTime": { },
  • "valuePeriod": { },
  • "dataAbsentReason": { },
  • "interpretation": [
    ],
  • "note": [
    ],
  • "bodySite": { },
  • "method": { },
  • "specimen": { },
  • "device": { },
  • "referenceRange": [
    ],
  • "hasMember": [
    ],
  • "derivedFrom": [
    ],
  • "component": [
    ]
}

Response samples

Content type
application/fhir+json
{
  • "resourceType": "Observation",
  • "id": "string",
  • "meta": {
    },
  • "implicitRules": "string",
  • "_implicitRules": { },
  • "language": "string",
  • "_language": { },
  • "text": {
    },
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "basedOn": [
    ],
  • "partOf": [
    ],
  • "status": "registered",
  • "_status": { },
  • "category": [
    ],
  • "code": { },
  • "subject": { },
  • "focus": [
    ],
  • "encounter": { },
  • "effectiveDateTime": "string",
  • "_effectiveDateTime": { },
  • "effectivePeriod": { },
  • "effectiveTiming": { },
  • "effectiveInstant": "string",
  • "_effectiveInstant": { },
  • "issued": "string",
  • "_issued": { },
  • "performer": [
    ],
  • "valueQuantity": { },
  • "valueCodeableConcept": { },
  • "valueString": "string",
  • "_valueString": { },
  • "valueBoolean": true,
  • "_valueBoolean": { },
  • "valueInteger": 0,
  • "_valueInteger": { },
  • "valueRange": { },
  • "valueRatio": { },
  • "valueSampledData": { },
  • "valueTime": "string",
  • "_valueTime": { },
  • "valueDateTime": "string",
  • "_valueDateTime": { },
  • "valuePeriod": { },
  • "dataAbsentReason": { },
  • "interpretation": [
    ],
  • "note": [
    ],
  • "bodySite": { },
  • "method": { },
  • "specimen": { },
  • "device": { },
  • "referenceRange": [
    ],
  • "hasMember": [
    ],
  • "derivedFrom": [
    ],
  • "component": [
    ]
}

updateObservation

Update Observation resource

Update the current state of the resource

Update an instance of an observation resource using the resource's unique id. Note that this will result in a version of the resource being preserved on the server which can be retrieved using the vread parameter See vreadObservation

Authorizations:
oauth-client-credentialsapi_key
path Parameters
rid
required
string
Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0"

id of the resource (=Resource.id)

query Parameters
_summary
string
Enum: "true" "text" "data" "count" "false"

Requests the server to return a designated subset of the resource

_elements
Array of any <string> [ items <string > ]

Requests the server to return a collection of elements from the resource

Request Body schema: application/fhir+json
required

The new state of the resource

resourceType
required
any
Value: "Observation"

This is a Observation resource

id
string^[A-Za-z0-9\-\.]{1,64}$

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

object

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
string^\S*$

String of characters used to identify a name or a resource

object

Base definition for all elements in a resource.

language
string^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

object

Base definition for all elements in a resource.

object

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.

extension
Array of any

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 of any

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).

Array of objects

A unique identifier assigned to this observation.

Array of objects

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 of any

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

status
any
Enum: "registered" "preliminary" "final" "amended" "corrected" "cancelled" "entered-in-error" "unknown"

The status of the result value.

object

Base definition for all elements in a resource.

category
Array of any

A code that classifies the general type of observation being made.

required
object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

object

A reference from one resource to another.

focus
Array of any

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.

object

A reference from one resource to another.

effectiveDateTime
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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.

object

Base definition for all elements in a resource.

object

A time period defined by a start and end date and optionally time.

object

Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

effectiveInstant
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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.

object

Base definition for all elements in a resource.

issued
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

object

Base definition for all elements in a resource.

performer
Array of any

Who was responsible for asserting the observed value as "true".

object

A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

valueString
string^[ \r\n\t\S]+$

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

valueBoolean
boolean^true|false$

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

valueInteger
number^-?([0]|([1-9][0-9]*))$

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

object

The information determined as a result of making the observation, if the information has a simple value.

object

The information determined as a result of making the observation, if the information has a simple value.

object

The information determined as a result of making the observation, if the information has a simple value.

valueTime
string^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60...

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

valueDateTime
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The information determined as a result of making the observation, if the information has a simple value.

object

Base definition for all elements in a resource.

object

A time period defined by a start and end date and optionally time.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

interpretation
Array of any

A categorical assessment of an observation value. For example, high, low, normal.

Array of objects

Comments about the observation or the results.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

object

A reference from one resource to another.

object

A reference from one resource to another.

Array of objects

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 of any

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 of any

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.

Array of objects

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.

Responses

Request samples

Content type
application/fhir+json
{
  • "resourceType": "Observation",
  • "id": "string",
  • "meta": {
    },
  • "implicitRules": "string",
  • "_implicitRules": { },
  • "language": "string",
  • "_language": { },
  • "text": {
    },
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "basedOn": [
    ],
  • "partOf": [
    ],
  • "status": "registered",
  • "_status": { },
  • "category": [
    ],
  • "code": { },
  • "subject": { },
  • "focus": [
    ],
  • "encounter": { },
  • "effectiveDateTime": "string",
  • "_effectiveDateTime": { },
  • "effectivePeriod": { },
  • "effectiveTiming": { },
  • "effectiveInstant": "string",
  • "_effectiveInstant": { },
  • "issued": "string",
  • "_issued": { },
  • "performer": [
    ],
  • "valueQuantity": { },
  • "valueCodeableConcept": { },
  • "valueString": "string",
  • "_valueString": { },
  • "valueBoolean": true,
  • "_valueBoolean": { },
  • "valueInteger": 0,
  • "_valueInteger": { },
  • "valueRange": { },
  • "valueRatio": { },
  • "valueSampledData": { },
  • "valueTime": "string",
  • "_valueTime": { },
  • "valueDateTime": "string",
  • "_valueDateTime": { },
  • "valuePeriod": { },
  • "dataAbsentReason": { },
  • "interpretation": [
    ],
  • "note": [
    ],
  • "bodySite": { },
  • "method": { },
  • "specimen": { },
  • "device": { },
  • "referenceRange": [
    ],
  • "hasMember": [
    ],
  • "derivedFrom": [
    ],
  • "component": [
    ]
}

Response samples

Content type
application/fhir+json
{
  • "resourceType": "Observation",
  • "id": "string",
  • "meta": {
    },
  • "implicitRules": "string",
  • "_implicitRules": { },
  • "language": "string",
  • "_language": { },
  • "text": {
    },
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "basedOn": [
    ],
  • "partOf": [
    ],
  • "status": "registered",
  • "_status": { },
  • "category": [
    ],
  • "code": { },
  • "subject": { },
  • "focus": [
    ],
  • "encounter": { },
  • "effectiveDateTime": "string",
  • "_effectiveDateTime": { },
  • "effectivePeriod": { },
  • "effectiveTiming": { },
  • "effectiveInstant": "string",
  • "_effectiveInstant": { },
  • "issued": "string",
  • "_issued": { },
  • "performer": [
    ],
  • "valueQuantity": { },
  • "valueCodeableConcept": { },
  • "valueString": "string",
  • "_valueString": { },
  • "valueBoolean": true,
  • "_valueBoolean": { },
  • "valueInteger": 0,
  • "_valueInteger": { },
  • "valueRange": { },
  • "valueRatio": { },
  • "valueSampledData": { },
  • "valueTime": "string",
  • "_valueTime": { },
  • "valueDateTime": "string",
  • "_valueDateTime": { },
  • "valuePeriod": { },
  • "dataAbsentReason": { },
  • "interpretation": [
    ],
  • "note": [
    ],
  • "bodySite": { },
  • "method": { },
  • "specimen": { },
  • "device": { },
  • "referenceRange": [
    ],
  • "hasMember": [
    ],
  • "derivedFrom": [
    ],
  • "component": [
    ]
}

deleteObservation

Delete Observation resource

Delete the resource so that it no exists (no read, search etc)

Permanently delete an instance of an observation resource from the server

Authorizations:
oauth-client-credentialsapi_key
path Parameters
rid
required
string
Example: "545b5afc-e3c9-4ebb-98e0-57f3bfebd5e0"

id of the resource (=Resource.id)

Responses

Response samples

Content type
application/fhir+json
{
  • "resourceType": "OperationOutcome",
  • "text": {
    },
  • "issue": [
    ]
}