Jump to

• Request
• Response

Get an observation by ID

get

/Observation/{id}

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves an individual observation by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful retrieve response.

Body ()

Root Schema : Observation

Type: object

Show Source

• category(required): array category

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

  For the following vital sign profiles, category.coding.system is set to http://terminology.hl7.org/CodeSystem/observation-category and category.coding.code is set to vital-signs:

  • Blood Pressure
  • BMI
  • Body Height
  • Body Temperature
  • Body Weight
  • Head Circumference
  • Head Occipital Frontal Circumference Percentile
  • Heart Rate
  • Pediatric BMI for Age
  • Pediatric Weight for Height
  • Pulse Oximetry
  • Respiratory Rate
  • Vital Signs

• code(required): code
  (USCDI) What was observed.
• component: array component

  (USCDI) The component observations that are part of this observation.

  For each component, only one value[x] representation is returned (for example, valueQuantity or valueCodeableConcept).

• dataAbsentReason: dataAbsentReason
  (USCDI) A reason why the expected value is missing.
• derivedFrom: array derivedFrom
  The related measurements the observation is made from.
• effectiveDateTime: string (date-time)
  (USCDI) The clinically relevant time or time period for the observation.
• effectivePeriod: effectivePeriod
  (USCDI) The clinically relevant time or time period for the observation.
• hasMember: array hasMember
  A related resource that belongs to the observation group.
• id(required): string
• performer: array performer
  The individual who is responsible for the observation.
• resourceType(required): string
  Allowed Values: [ "Observation" ]
• specimen: specimen
  (USCDI) The specimen used for this observation.
• status(required): string
  (USCDI) The status of the result value.
• subject(required): subject
  (USCDI) Who or what the observation is about.
• valueCodeableConcept: valueCodeableConcept
  (USCDI) The result value as a coded concept.
• valueQuantity: valueQuantity

  (USCDI) The result value as a quantity.

  • For the following vital sign profiles, valueQuantity.system is set to http://unitsofmeasure.org:
    • Body Height
    • Body Temperature
    • Body Weight
    • Head Circumference
    • Heart Rate
    • Respiratory Rate
    • Pulse Oximetry
    • BMI
    • Pediatric BMI for Age
    • Pediatric Weight for Height
    • Head Occipital Frontal Circumference Percentile
  • For BMI, valueQuantity.code is set to kg/m2.
  • For Heart Rate and Respiratory Rate, valueQuantity.code is set to /min.
  • For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile, valueQuantity.code is set to %.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "category",
        "code",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Observation"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The status of the result value."
        },
        "category":{
            "type":"array",
            "description":"<p>(USCDI) A code that classifies the general type of observation being made.</p>\n<p>For the following vital sign profiles, <code>category.coding.system</code> is set to <code>http://terminology.hl7.org/CodeSystem/observation-category</code> and <code>category.coding.code</code> is set to <code>vital-signs</code>:\n<ul>\n  <li>Blood Pressure</li>\n  <li>BMI</li>\n  <li>Body Height</li>\n  <li>Body Temperature</li>\n  <li>Body Weight</li>\n  <li>Head Circumference</li>\n  <li>Head Occipital Frontal Circumference Percentile</li>\n  <li>Heart Rate</li>\n  <li>Pediatric BMI for Age</li>\n  <li>Pediatric Weight for Height</li>\n  <li>Pulse Oximetry</li>\n  <li>Respiratory Rate</li>\n  <li>Vital Signs</li>\n</ul>\n",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "code":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) What was observed."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) Who or what the observation is about."
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The clinically relevant time or time period for the observation."
        },
        "effectivePeriod":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"(USCDI) The clinically relevant time or time period for the observation."
        },
        "performer":{
            "type":"array",
            "description":"The individual who is responsible for the observation.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "valueQuantity":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Quantity"
                }
            ],
            "description":"<p>(USCDI) The result value as a quantity.</p>\n<ul>\n  <li>For the following vital sign profiles, <code>valueQuantity.system</code> is set to <code>http://unitsofmeasure.org</code>:\n    <ul>\n      <li>Body Height</li>\n      <li>Body Temperature</li>\n      <li>Body Weight</li>\n      <li>Head Circumference</li>\n      <li>Heart Rate</li>\n      <li>Respiratory Rate</li>\n      <li>Pulse Oximetry</li>\n      <li>BMI</li>\n      <li>Pediatric BMI for Age</li>\n      <li>Pediatric Weight for Height</li>\n      <li>Head Occipital Frontal Circumference Percentile</li>\n    </ul></li>\n  <li>For BMI, <code>valueQuantity.code</code> is set to <code>kg/m2</code>.</li>\n  <li>For Heart Rate and Respiratory Rate, <code>valueQuantity.code</code> is set to <code>/min</code>.</li>\n  <li>For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile, <code>valueQuantity.code</code> is set to <code>%</code>.</li>\n</ul>\n",
            "nullable":true
        },
        "valueCodeableConcept":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The result value as a coded concept.",
            "nullable":true
        },
        "dataAbsentReason":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) A reason why the expected value is missing."
        },
        "specimen":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The specimen used for this observation."
        },
        "hasMember":{
            "type":"array",
            "description":"A related resource that belongs to the observation group.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "derivedFrom":{
            "type":"array",
            "description":"The related measurements the observation is made from.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "component":{
            "type":"array",
            "description":"<p>(USCDI) The component observations that are part of this observation.</p>\n<p>For each component, only one <code>value[x]</code> representation is returned (for example, <code>valueQuantity</code> or <code>valueCodeableConcept</code>).</p>\n",
            "items":{
                "$ref":"#/components/schemas/ObservationComponent"
            }
        }
    }
}

Nested Schema : category

Type: array

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

For the following vital sign profiles, category.coding.system is set to http://terminology.hl7.org/CodeSystem/observation-category and category.coding.code is set to vital-signs:

• Blood Pressure
• BMI
• Body Height
• Body Temperature
• Body Weight
• Head Circumference
• Head Occipital Frontal Circumference Percentile
• Heart Rate
• Pediatric BMI for Age
• Pediatric Weight for Height
• Pulse Oximetry
• Respiratory Rate
• Vital Signs

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"<p>(USCDI) A code that classifies the general type of observation being made.</p>\n<p>For the following vital sign profiles, <code>category.coding.system</code> is set to <code>http://terminology.hl7.org/CodeSystem/observation-category</code> and <code>category.coding.code</code> is set to <code>vital-signs</code>:\n<ul>\n  <li>Blood Pressure</li>\n  <li>BMI</li>\n  <li>Body Height</li>\n  <li>Body Temperature</li>\n  <li>Body Weight</li>\n  <li>Head Circumference</li>\n  <li>Head Occipital Frontal Circumference Percentile</li>\n  <li>Heart Rate</li>\n  <li>Pediatric BMI for Age</li>\n  <li>Pediatric Weight for Height</li>\n  <li>Pulse Oximetry</li>\n  <li>Respiratory Rate</li>\n  <li>Vital Signs</li>\n</ul>\n",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : code

(USCDI) What was observed.

Match All

(USCDI) What was observed.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) What was observed."
}

Nested Schema : component

Type: array

(USCDI) The component observations that are part of this observation.

For each component, only one value[x] representation is returned (for example, valueQuantity or valueCodeableConcept).

Show Source

• Array of: object ObservationComponent

{
    "type":"array",
    "description":"<p>(USCDI) The component observations that are part of this observation.</p>\n<p>For each component, only one <code>value[x]</code> representation is returned (for example, <code>valueQuantity</code> or <code>valueCodeableConcept</code>).</p>\n",
    "items":{
        "$ref":"#/components/schemas/ObservationComponent"
    }
}

Nested Schema : dataAbsentReason

(USCDI) A reason why the expected value is missing.

Match All

(USCDI) A reason why the expected value is missing.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) A reason why the expected value is missing."
}

Nested Schema : derivedFrom

Type: array

The related measurements the observation is made from.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"The related measurements the observation is made from.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : effectivePeriod

(USCDI) The clinically relevant time or time period for the observation.

Match All

(USCDI) The clinically relevant time or time period for the observation.

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"(USCDI) The clinically relevant time or time period for the observation."
}

Nested Schema : hasMember

Type: array

A related resource that belongs to the observation group.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"A related resource that belongs to the observation group.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : performer

Type: array

The individual who is responsible for the observation.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"The individual who is responsible for the observation.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : specimen

(USCDI) The specimen used for this observation.

Match All

(USCDI) The specimen used for this observation.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The specimen used for this observation."
}

Nested Schema : subject

(USCDI) Who or what the observation is about.

Match All

(USCDI) Who or what the observation is about.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) Who or what the observation is about."
}

Nested Schema : valueCodeableConcept

(USCDI) The result value as a coded concept.

Match All

(USCDI) The result value as a coded concept.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The result value as a coded concept.",
    "nullable":true
}

Nested Schema : valueQuantity

(USCDI) The result value as a quantity.

• For the following vital sign profiles, valueQuantity.system is set to http://unitsofmeasure.org:
  • Body Height
  • Body Temperature
  • Body Weight
  • Head Circumference
  • Heart Rate
  • Respiratory Rate
  • Pulse Oximetry
  • BMI
  • Pediatric BMI for Age
  • Pediatric Weight for Height
  • Head Occipital Frontal Circumference Percentile
• For BMI, valueQuantity.code is set to kg/m2.
• For Heart Rate and Respiratory Rate, valueQuantity.code is set to /min.
• For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile, valueQuantity.code is set to %.

Match All

(USCDI) The result value as a quantity.

• For the following vital sign profiles, valueQuantity.system is set to http://unitsofmeasure.org:
  • Body Height
  • Body Temperature
  • Body Weight
  • Head Circumference
  • Heart Rate
  • Respiratory Rate
  • Pulse Oximetry
  • BMI
  • Pediatric BMI for Age
  • Pediatric Weight for Height
  • Head Occipital Frontal Circumference Percentile
• For BMI, valueQuantity.code is set to kg/m2.
• For Heart Rate and Respiratory Rate, valueQuantity.code is set to /min.
• For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile, valueQuantity.code is set to %.

Show Source

• object Quantity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Quantity"
        }
    ],
    "description":"<p>(USCDI) The result value as a quantity.</p>\n<ul>\n  <li>For the following vital sign profiles, <code>valueQuantity.system</code> is set to <code>http://unitsofmeasure.org</code>:\n    <ul>\n      <li>Body Height</li>\n      <li>Body Temperature</li>\n      <li>Body Weight</li>\n      <li>Head Circumference</li>\n      <li>Heart Rate</li>\n      <li>Respiratory Rate</li>\n      <li>Pulse Oximetry</li>\n      <li>BMI</li>\n      <li>Pediatric BMI for Age</li>\n      <li>Pediatric Weight for Height</li>\n      <li>Head Occipital Frontal Circumference Percentile</li>\n    </ul></li>\n  <li>For BMI, <code>valueQuantity.code</code> is set to <code>kg/m2</code>.</li>\n  <li>For Heart Rate and Respiratory Rate, <code>valueQuantity.code</code> is set to <code>/min</code>.</li>\n  <li>For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile, <code>valueQuantity.code</code> is set to <code>%</code>.</li>\n</ul>\n",
    "nullable":true
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : ObservationComponent

Type: object

Show Source

• code(required): code
  (USCDI) The type of component observation.
• dataAbsentReason: dataAbsentReason
  (USCDI) A reason why the expected component value is missing.
• valueCodeableConcept: valueCodeableConcept
  (USCDI) The component observation value as a coded concept.
• valueQuantity: valueQuantity

  (USCDI) The component observation value as a quantity.

  • For Blood Pressure component values, valueQuantity.system is set to http://unitsofmeasure.org and valueQuantity.code is set to mm[Hg].
  • For Pulse Oximetry components, valueQuantity.system is set to http://unitsofmeasure.org. Component values may use L/min or % depending on component code.

{
    "type":"object",
    "required":[
        "code"
    ],
    "properties":{
        "code":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The type of component observation."
        },
        "valueQuantity":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Quantity"
                }
            ],
            "description":"<p>(USCDI) The component observation value as a quantity.</p>\n<ul>\n  <li>For Blood Pressure component values, <code>valueQuantity.system</code> is set to <code>http://unitsofmeasure.org</code> and <code>valueQuantity.code</code> is set to <code>mm[Hg]</code>.</li>\n  <li>For Pulse Oximetry components, <code>valueQuantity.system</code> is set to <code>http://unitsofmeasure.org</code>. Component values may use <code>L/min</code> or <code>%</code> depending on component code.</li>\n</ul>\n",
            "nullable":true
        },
        "valueCodeableConcept":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The component observation value as a coded concept.",
            "nullable":true
        },
        "dataAbsentReason":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) A reason why the expected component value is missing."
        }
    }
}

Nested Schema : code

(USCDI) The type of component observation.

Match All

(USCDI) The type of component observation.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The type of component observation."
}

Nested Schema : dataAbsentReason

(USCDI) A reason why the expected component value is missing.

Match All

(USCDI) A reason why the expected component value is missing.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) A reason why the expected component value is missing."
}

Nested Schema : valueCodeableConcept

(USCDI) The component observation value as a coded concept.

Match All

(USCDI) The component observation value as a coded concept.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The component observation value as a coded concept.",
    "nullable":true
}

Nested Schema : valueQuantity

(USCDI) The component observation value as a quantity.

• For Blood Pressure component values, valueQuantity.system is set to http://unitsofmeasure.org and valueQuantity.code is set to mm[Hg].
• For Pulse Oximetry components, valueQuantity.system is set to http://unitsofmeasure.org. Component values may use L/min or % depending on component code.

Match All

(USCDI) The component observation value as a quantity.

• For Blood Pressure component values, valueQuantity.system is set to http://unitsofmeasure.org and valueQuantity.code is set to mm[Hg].
• For Pulse Oximetry components, valueQuantity.system is set to http://unitsofmeasure.org. Component values may use L/min or % depending on component code.

Show Source

• object Quantity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Quantity"
        }
    ],
    "description":"<p>(USCDI) The component observation value as a quantity.</p>\n<ul>\n  <li>For Blood Pressure component values, <code>valueQuantity.system</code> is set to <code>http://unitsofmeasure.org</code> and <code>valueQuantity.code</code> is set to <code>mm[Hg]</code>.</li>\n  <li>For Pulse Oximetry components, <code>valueQuantity.system</code> is set to <code>http://unitsofmeasure.org</code>. Component values may use <code>L/min</code> or <code>%</code> depending on component code.</li>\n</ul>\n",
    "nullable":true
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• system: string (uri)
• unit: string
• value: number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string"
        },
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top