Jump to

• Request
• Response

Get an observation by ID

get

/Observation/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

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 OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Observation

Type: object

A measurement, assertion, or grouped result about a patient.

Show Source

• category(required): array category
  The observation classification.
• code(required): object CodeableConcept
• component: array component
  The component results.
• dataAbsentReason: object CodeableConcept
• derivedFrom: array derivedFrom
  The related source observations.
• effectiveDateTime: effectiveDateTime
  The clinically relevant time for the observation.
• effectivePeriod: object PeriodForObservation
• hasMember: array hasMember
  The member observations.
• id(required): string
  The logical ID of the observation.
• interpretation: array interpretation
  The interpretation of the result.
• issued: string (date-time)
  The time the version became available.
• meta: object meta
• performer: array performer
  The responsible practitioners.
• referenceRange: array referenceRange
  The reference ranges for the result.
• resourceType(required): string
  Allowed Values: [ "Observation" ]
• specimen: object ReferenceForObservation
• status(required): string
  Allowed Values: [ "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", "unknown" ]

  The observation status.
• subject(required): object ReferenceForObservation
• text: object Narrative
• valueCodeableConcept: object CodeableConcept
• valueDateTime: string (date-time)
  The date and time result.
• valueQuantity: object Quantity
• valueString: string
  The string result.
• valueTime: string
  The time result.

{
    "type":"object",
    "description":"A measurement, assertion, or grouped result about a patient.",
    "required":[
        "resourceType",
        "id",
        "status",
        "category",
        "code",
        "subject"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Observation"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the observation."
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string",
                    "description":"The version-specific identifier."
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The last update time."
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "status":{
            "type":"string",
            "enum":[
                "registered",
                "preliminary",
                "final",
                "amended",
                "corrected",
                "cancelled",
                "entered-in-error",
                "unknown"
            ],
            "description":"The observation status."
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            },
            "description":"The observation classification."
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForObservation"
        },
        "effectiveDateTime":{
            "description":"The clinically relevant time for the observation.",
            "oneOf":[
                {
                    "type":"string",
                    "format":"date-time"
                },
                {
                    "$ref":"#/components/schemas/PrimitiveElementForObservation"
                }
            ]
        },
        "effectivePeriod":{
            "$ref":"#/components/schemas/PeriodForObservation"
        },
        "issued":{
            "type":"string",
            "format":"date-time",
            "description":"The time the version became available."
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForObservation"
            },
            "description":"The responsible practitioners."
        },
        "valueString":{
            "type":"string",
            "description":"The string result."
        },
        "valueQuantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time result."
        },
        "valueTime":{
            "type":"string",
            "description":"The time result."
        },
        "dataAbsentReason":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "interpretation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            },
            "description":"The interpretation of the result."
        },
        "referenceRange":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceRangeForObservation"
            },
            "description":"The reference ranges for the result."
        },
        "specimen":{
            "$ref":"#/components/schemas/ReferenceForObservation"
        },
        "derivedFrom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForObservation"
            },
            "description":"The related source observations."
        },
        "hasMember":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForObservation"
            },
            "description":"The member observations."
        },
        "component":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ComponentForObservation"
            },
            "description":"The component results."
        }
    }
}

Nested Schema : category

Type: array

The observation classification.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    },
    "description":"The observation classification."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : component

Type: array

The component results.

Show Source

• Array of: object ComponentForObservation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ComponentForObservation"
    },
    "description":"The component results."
}

Nested Schema : derivedFrom

Type: array

The related source observations.

Show Source

• Array of: object ReferenceForObservation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForObservation"
    },
    "description":"The related source observations."
}

Nested Schema : effectiveDateTime

The clinically relevant time for the observation.

Match One Schema

Show Source

• string(date-time)
• object PrimitiveElementForObservation

{
    "description":"The clinically relevant time for the observation.",
    "oneOf":[
        {
            "type":"string",
            "format":"date-time"
        },
        {
            "$ref":"#/components/schemas/PrimitiveElementForObservation"
        }
    ]
}

Nested Schema : PeriodForObservation

Type: object

Show Source

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

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForObservation"
            }
        }
    }
}

Nested Schema : hasMember

Type: array

The member observations.

Show Source

• Array of: object ReferenceForObservation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForObservation"
    },
    "description":"The member observations."
}

Nested Schema : interpretation

Type: array

The interpretation of the result.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    },
    "description":"The interpretation of the result."
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
  The last update time.
• security: array security
• versionId: string
  The version-specific identifier.

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string",
            "description":"The version-specific identifier."
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The last update time."
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : performer

Type: array

The responsible practitioners.

Show Source

• Array of: object ReferenceForObservation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForObservation"
    },
    "description":"The responsible practitioners."
}

Nested Schema : referenceRange

Type: array

The reference ranges for the result.

Show Source

• Array of: object ReferenceRangeForObservation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceRangeForObservation"
    },
    "description":"The reference ranges for the result."
}

Nested Schema : ReferenceForObservation

Type: object

Show Source

• reference: string

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

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• comparator: string
• system: string
• unit: string
• value: number

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

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : ComponentForObservation

Type: object

Show Source

• code(required): object CodeableConcept
• dataAbsentReason: object CodeableConcept
• interpretation: array interpretation
• referenceRange: array referenceRange
• valueCodeableConcept: object CodeableConcept
• valueDateTime: string (date-time)
• valueQuantity: object Quantity
• valueString: string
• valueTime: string

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "code"
    ],
    "properties":{
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "valueString":{
            "type":"string"
        },
        "valueQuantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "valueTime":{
            "type":"string"
        },
        "dataAbsentReason":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "interpretation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "referenceRange":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceRangeForObservation"
            }
        }
    }
}

Nested Schema : interpretation

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : referenceRange

Type: array

Show Source

• Array of: object ReferenceRangeForObservation

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

Nested Schema : ReferenceRangeForObservation

Type: object

Show Source

• high: object Quantity
• low: object Quantity
• type: object CodeableConcept

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "low":{
            "$ref":"#/components/schemas/Quantity"
        },
        "high":{
            "$ref":"#/components/schemas/Quantity"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : PrimitiveElementForObservation

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForObservation"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForObservation

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

Nested Schema : ExtensionForObservation

Type: object

Show Source

• url: string
• valueCode: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "url":{
            "type":"string"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForObservation

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

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top