HDR FHIR API

GET Observation Resource Bundle

get

/oracle-fhir-server/fhir/Observation

This endpoint supports the retrieval of Observation resource list.It returns Bundle of Observation resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
based-on(optional): string

Reference to the service request.
category(optional): string

The classification of the type of observation
code(optional): string

The code of the observation type
code-value-concept(optional): string

Code and coded value parameter pair
code-value-date(optional): string

Code and date/time value parameter pair
code-value-quantity(optional): string

Code and quantity value parameter pair
code-value-string(optional): string

Code and string value parameter pair
combo-code(optional): string

The code of the observation type or component type
combo-code-value-concept(optional): string

Code and coded value parameter pair, including in components
combo-code-value-quantity(optional): string

Code and quantity value parameter pair, including in components
combo-data-absent-reason(optional): string

The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.
combo-value-concept(optional): string

The value or component value of the observation, if the value is a CodeableConcept
combo-value-quantity(optional): integer

The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
component-code(optional): string

The component code of the observation type
component-code-value-concept(optional): string

Component code and component coded value parameter pair
component-code-value-quantity(optional): string

Component code and component quantity value parameter pair
component-data-absent-reason(optional): string

The reason why the expected value in the element Observation.component.value[x] is missing.
component-value-concept(optional): string

The value of the component observation, if the value is a CodeableConcept
component-value-quantity(optional): integer

The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
data-absent-reason(optional): string

The reason why the expected value in the element Observation.value[x] is missing.
date(optional): string(date)

Obtained date/time. If the obtained element is a period, a date that falls in the period
derived-from(optional): string

Related measurements the observation is made from
device(optional): string

The Device that generated the observation data.
encounter(optional): string

Encounter related to the observation
focus(optional): string

The focus of an observation when the focus is not the patient of record.
has-member(optional): string

Related resource that belongs to the Observation group
identifier(optional): string

The unique id for a particular observation
method(optional): string

The method used for the observation
part-of(optional): string

Part of referenced event
patient(optional): string

The subject that the observation is about (if patient)
performer(optional): string

Who performed the observation
specimen(optional): string

Specimen used for this observation
status(optional): string

The status of the observation
subject(optional): string

The subject that the observation is about
value-concept(optional): string

The value of the observation, if the value is a CodeableConcept
value-date(optional): string(date)

The value of the observation, if the value is a date or period of time
value-quantity(optional): integer

The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
value-string(optional): string

The value of the observation, if the value is a string, and also searches in CodeableConcept.text

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Observation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Observation"
    }
}

Nested Schema : Observation

Type: object

Show Source

category: array category

Minimum Number of Items: 1

Unique Items Required: true
code: object ActivityDefinition_valueCodeableConcept
effectiveDateTime: string

Minimum Length: 1
encounter: object Account_coverage
id: string

Minimum Length: 1
meta: object Account_meta
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_coverage
text: object Account_text
valueQuantity: object FamilyMemberHistory_onsetAge

{
    "type":"object",
    "required":[
        "category",
        "code",
        "effectiveDateTime",
        "encounter",
        "id",
        "meta",
        "resourceType",
        "status",
        "subject",
        "text",
        "valueQuantity"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "code":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "effectiveDateTime":{
            "type":"string",
            "minLength":1
        },
        "valueQuantity":{
            "$ref":"#/definitions/FamilyMemberHistory_onsetAge"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : category

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : FamilyMemberHistory_onsetAge

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1
unit: string

Minimum Length: 1
value: number

{
    "required":[
        "code",
        "system",
        "unit",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string",
            "minLength":1
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AdverseEvent_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}