Clinical Genomic APIs for Oracle Healthcare Foundation

Retrieve Observation for an Observation Identifier

get

/ohfapi/cg/v3.3/patientapi/observations/{id}

This endpoint supports the retrieval of Observation for a single Observation Identifier. It returns the observation linked to the identifier.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: integer(int64)

Minimum Value: 0

Observation Row ID

Security

basicAuth: basic

Type: basic

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Root Schema : Observation

Type: object

Show Source

batchNumber(optional): string

Batch Number
bodySite(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
category(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
clinicalspecimens(optional): object LinkedReference
code(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
diagPanel(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
diagPanelSet(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
effectiveDateTime(optional): string(date-time)

Effective Date
effectiveFromDateTime(optional): string(date-time)

Effective From Date
effectiveToDateTime(optional): string(date-time)

Effective To Date
encounter(optional): object Encounter
identifier(optional): object Identifier

Identifier assigned by a given system
medicationCode(optional): string

Medication Code
medicationName(optional): string

Medication Name
observationNumber(optional): string

Observation Number
observationValueNote(optional): string

Observation Value Note
observationValueText(optional): string

Observation Value Text
patient(optional): object LinkedReference
patientcondition(optional): object LinkedReference
performer(optional): object Practitioner

Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.
referenceRange(optional): object ReferenceRange
specimenNumber(optional): string

Specimen Number
specimenType(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
specimenVendorNumber(optional): string

Specimen Vendor Number
subject(optional): object LinkedReference
subType(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
type(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
valueCodeableConcept(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
valueQuantity(optional): object Quantity

Model for a Quantity object in CDM.
valueString(optional): string

String Value

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Observation Identifier",
            "$ref":"#/definitions/Identifier"
        },
        "category":{
            "description":"Category CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "code":{
            "description":"Code CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "subject":{
            "example":"{href: '/subjectapi/subjects/{subjectId}'}",
            "description":"A link containing href to retrieve Subject details",
            "$ref":"#/definitions/LinkedReference"
        },
        "patient":{
            "example":"{href: '/patientapi/patients/{patientId}'}",
            "description":"A link containing href to retrieve Patient details",
            "$ref":"#/definitions/LinkedReference"
        },
        "encounter":{
            "description":"Encounter Details",
            "$ref":"#/definitions/Encounter"
        },
        "performer":{
            "description":"Performer Detials",
            "$ref":"#/definitions/Practitioner"
        },
        "valueQuantity":{
            "description":"Quantity Details",
            "$ref":"#/definitions/Quantity"
        },
        "valueCodeableConcept":{
            "description":"Value CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "valueString":{
            "type":"string",
            "description":"String Value"
        },
        "bodySite":{
            "description":"Body Site CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "specimenType":{
            "description":"Specimen Type CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "clinicalspecimens":{
            "example":"{href: '/patientapi/clinicalspecimens/{specimenId}'}",
            "description":"A link containing href to retrieve Clinical Specimen details",
            "$ref":"#/definitions/LinkedReference"
        },
        "patientcondition":{
            "example":"{href: '/patientapi/conditions/{conditionId}'}",
            "description":"A link containing href to retrieve Condition details",
            "$ref":"#/definitions/LinkedReference"
        },
        "referenceRange":{
            "description":"Reference Range Details",
            "$ref":"#/definitions/ReferenceRange"
        },
        "specimenNumber":{
            "type":"string",
            "description":"Specimen Number"
        },
        "specimenVendorNumber":{
            "type":"string",
            "description":"Specimen Vendor Number"
        },
        "batchNumber":{
            "type":"string",
            "description":"Batch Number"
        },
        "observationNumber":{
            "type":"string",
            "description":"Observation Number"
        },
        "observationValueText":{
            "type":"string",
            "description":"Observation Value Text"
        },
        "observationValueNote":{
            "type":"string",
            "description":"Observation Value Note"
        },
        "subType":{
            "description":"SubType CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "diagPanelSet":{
            "description":"DiagPanelSet CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "diagPanel":{
            "description":"DiagPanel CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "type":{
            "description":"Type CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "medicationCode":{
            "type":"string",
            "description":"Medication Code"
        },
        "medicationName":{
            "type":"string",
            "description":"Medication Name"
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date"
        },
        "effectiveFromDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective From Date"
        },
        "effectiveToDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective To Date"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Show Source

coding(optional): array coding

Read Only: true

Code(s) defined by a terminology system.
text(optional): string

Plain text representation of the concept.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Plain text representation of the concept."
        },
        "coding":{
            "type":"array",
            "description":"Code(s) defined by a terminology system.",
            "readOnly":true,
            "items":{
                "xml":{
                    "name":"coding"
                },
                "$ref":"#/definitions/Coding"
            }
        }
    },
    "description":"Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text."
}

Nested Schema : LinkedReference

Type: object

Show Source

display(optional): string
reference(optional): string

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

Nested Schema : Encounter

Type: object

Show Source

identifier(optional): object CdmIdentifier

Identifier assigned by a given system
location(optional): object Location
sequence(optional): object Number
type(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"Encounter type information for this encounter. Details such as encounter type code, name , description.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "location":{
            "description":"The location or facility details of the encounter.",
            "$ref":"#/definitions/Location"
        },
        "sequence":{
            "description":"The sequence or priority of the event within an encounter e.g. 1, 2 etc.",
            "$ref":"#/definitions/Number"
        }
    }
}

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Show Source

system(optional): string

System which assigned this identifier
value(optional): string

Identifier value

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : Practitioner

Type: object

Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.

Show Source

address(optional): object Address

Model for a postal address.
identifier(optional): object CdmIdentifier

Identifier assigned by a given system
name(optional): object HumanName

Model for a name of a human with text and parts information.
speciality(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
specimenAliasIssuerFlag(optional): string

The flag that indicates that this Service Provider has issued Specimen Alias(es).
telecom(optional): object Telecom
type(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Healthcare service provider system identifier. It can include a service provider Row ID value or service provider unique identifier.",
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"The healthcare practitioner type or role, i.e. type/role code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "name":{
            "description":"A name associated with the person.",
            "$ref":"#/definitions/HumanName"
        },
        "telecom":{
            "description":"A contact detail for the practitioner. For example, the telephone number, email, or fax.",
            "$ref":"#/definitions/Telecom"
        },
        "address":{
            "description":"Where practitioner can be found/visited.",
            "$ref":"#/definitions/Address"
        },
        "speciality":{
            "description":"Detaile of the specific specialty of the practitioner, i.e. specialty code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "specimenAliasIssuerFlag":{
            "type":"string",
            "description":"The flag that indicates that this Service Provider has issued Specimen Alias(es)."
        }
    },
    "description":"Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility."
}

Nested Schema : ReferenceRange

Type: object

Show Source

high(optional): object Quantity

Model for a Quantity object in CDM.
low(optional): object Quantity

Model for a Quantity object in CDM.

{
    "type":"object",
    "properties":{
        "low":{
            "$ref":"#/definitions/Quantity"
        },
        "high":{
            "$ref":"#/definitions/Quantity"
        }
    }
}

Nested Schema : Quantity

Type: object

Model for a Quantity object in CDM.

Show Source

code(optional): string

The quantity units symbol in syntax defined by the system.
description(optional): string

The quantity units description.
sysId(optional): string

The quantity units terminology system identifier.
sysName(optional): string

The quantity units terminology system name.
sysVersion(optional): string

The quantity units terminology system version.
units(optional): string

The quantity units displayable name.
value(optional): string

The numerical value of the quantity.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"The numerical value of the quantity."
        },
        "units":{
            "type":"string",
            "description":"The quantity units displayable name."
        },
        "code":{
            "type":"string",
            "description":"The quantity units symbol in syntax defined by the system."
        },
        "description":{
            "type":"string",
            "description":"The quantity units description."
        },
        "sysId":{
            "type":"string",
            "description":"The quantity units terminology system identifier."
        },
        "sysName":{
            "type":"string",
            "description":"The quantity units terminology system name."
        },
        "sysVersion":{
            "type":"string",
            "description":"The quantity units terminology system version."
        }
    },
    "description":"Model for a Quantity object in CDM."
}

Nested Schema : coding

Type: array

Read Only: true

Code(s) defined by a terminology system.

Show Source

Array of: object Coding

Model for a reference to a code defined by a terminology system.

{
    "type":"array",
    "description":"Code(s) defined by a terminology system.",
    "readOnly":true,
    "items":{
        "xml":{
            "name":"coding"
        },
        "$ref":"#/definitions/Coding"
    }
}

Nested Schema : Coding

Type: object

Model for a reference to a code defined by a terminology system.

Show Source

code(optional): string

Symbol in syntax defined by the system.
description(optional): string

Description defined by the system.
display(optional): string

Representation defined by the system.
srvcProviderId(optional): string

Service Provider Id of Specimen Alias .
srvcProviderName(optional): string

Service Provider Name of Specimen Alias .
sysId(optional): string

Identity of the terminology system.
sysName(optional): string

Name of the terminology system.
sysVersion(optional): string

Version of the system - if relevant.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Symbol in syntax defined by the system."
        },
        "display":{
            "type":"string",
            "description":"Representation defined by the system."
        },
        "description":{
            "type":"string",
            "description":"Description defined by the system."
        },
        "sysId":{
            "type":"string",
            "description":"Identity of the terminology system."
        },
        "sysName":{
            "type":"string",
            "description":"Name of the terminology system."
        },
        "sysVersion":{
            "type":"string",
            "description":"Version of the system - if relevant."
        },
        "srvcProviderId":{
            "type":"string",
            "description":"Service Provider Id of Specimen Alias ."
        },
        "srvcProviderName":{
            "type":"string",
            "description":"Service Provider Name of Specimen Alias ."
        }
    },
    "description":"Model for a reference to a code defined by a terminology system."
}

Nested Schema : CdmIdentifier

Type: object

Identifier assigned by a given system

Show Source

system(optional): string

System which assigned this identifier
value(optional): string

Identifier value

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : Location

Type: object

Show Source

identifier(optional): object CdmIdentifier

Identifier assigned by a given system
name(optional): string

Name of the facility.
type(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "name":{
            "type":"string",
            "description":"Name of the facility."
        },
        "type":{
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : Number

Type: object

Nested Schema : Address

Type: object

Model for a postal address.

Show Source

city(optional): string

Name of city, town etc.
country(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
district(optional): string

District name (aka county).
line(optional): array line

Street name, number, direction & P.O. Box etc.
postalCode(optional): string

Postal code for area.
state(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "line":{
            "type":"array",
            "description":"Street name, number, direction & P.O. Box etc.",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string",
            "description":"Name of city, town etc."
        },
        "district":{
            "type":"string",
            "description":"District name (aka county)."
        },
        "state":{
            "description":"Sub-unit of country (abbreviations ok).",
            "$ref":"#/definitions/CodeableConcept"
        },
        "postalCode":{
            "type":"string",
            "description":"Postal code for area."
        },
        "country":{
            "description":"Country (can be ISO 3166 3 letter code).",
            "$ref":"#/definitions/CodeableConcept"
        }
    },
    "description":"Model for a postal address."
}

Nested Schema : HumanName

Type: object

Model for a name of a human with text and parts information.

Show Source

family(optional): string

Family name (often called 'Surname').
given(optional): array given

Given names (not always 'first'). Includes middle names.
text(optional): string

Text representation of the full name.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Text representation of the full name."
        },
        "family":{
            "type":"string",
            "description":"Family name (often called 'Surname')."
        },
        "given":{
            "type":"array",
            "description":"Given names (not always 'first'). Includes middle names.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for a name of a human with text and parts information."
}

Nested Schema : Telecom

Type: object

Show Source

use(optional): object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.
value(optional): string

Telecom Value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Telecom Value"
        },
        "use":{
            "description":"Telecom Use CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : line

Type: array

Street name, number, direction & P.O. Box etc.

Show Source

Array of: string

{
    "type":"array",
    "description":"Street name, number, direction & P.O. Box etc.",
    "items":{
        "type":"string"
    }
}

Nested Schema : given

Type: array

Given names (not always 'first'). Includes middle names.

Show Source

Array of: string

{
    "type":"array",
    "description":"Given names (not always 'first'). Includes middle names.",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid parameters supplied

404 Response

Observation not found

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/observations/10001/

Example of Response Body

The following example shows the response returned in JSON format.

{
     "identifier": {
         "system": "CDM",
         "value": "10001"
     },
     "category": {
         "coding": [
             {
                 "code": "OBTYPE1",
                 "display": "OBTYPE1name",
                 "description": "Observation Type Description"
             }
         ]
     },
     "code": {
         "coding": [
             {
                 "code": "1",
                 "display": "OBSV1",
                 "description": "Observation Description",
                 "sysId": "1",
                 "sysName": "Code System 1",
                 "sysVersion": "Version 1"
             }
         ]
     },
     "patient": {
         "reference": "/ohfapi/cg/v3.3/patientapi/patients/2"
     },
     "encounter": {
         "identifier": {
             "system": "CDM",
             "value": "ENC1"
         },
         "type": {
             "coding": [
                 {
                     "code": "1",
                     "display": "ENC_TYPE1",
                     "description": "ENC_TYPE_DESC1",
                     "sysId": "EHA_CUSTOM_CD_SYS",
                     "sysName": "EHA Custom Code System",
                     "sysVersion": "1"
                 }
             ]
         },
         "location": {
             "identifier": {
                 "system": "CDM",
                 "value": "1"
             },
             "name": "FAC1",
             "type": {
                 "coding": [
                     {
                         "code": "FAC_SUBTYP_RM",
                         "display": "Room",
                         "description": "A space allocated for a function within a building or a floor",
                         "sysId": "EHA_CUSTOM_CD_SYS",
                         "sysName": "EHA Custom Code System",
                         "sysVersion": "1"
                     }
                 ]
             }
         },
         "sequence": 10001
     },
     "performer": {
         "identifier": {
             "system": "CDM",
             "value": "SVCPRV1"
         },
         "type": {
             "coding": [
                 {
                     "code": "SVCPRV_TYP_CD_VALUE",
                     "display": "SVCPRV_TYP_CD_NAME",
                     "description": "SVCPRV_TYP_CD_DESC",
                     "sysId": "SVCPRV_TYP_CD_SYS",
                     "sysName": "Service Provider System",
                     "sysVersion": "2"
                 }
             ]
         },
         "specimenAliasIssuerFlag": "Y"
     },
     "valueQuantity": {
         "value": "20",
         "units": "cm",
         "code": "1",
         "description": "centi meter",
         "sysId": "1",
         "sysName": "UOM code",
         "sysVersion": "UOM version"
     },
     "valueCodeableConcept": {
         "coding": [
             {
                 "code": "1",
                 "display": "OBS_VAL1",
                 "description": "OBSV_VAL_VIN_DESC_1",
                 "sysId": "EHA_CUSTOM_CD_SYS",
                 "sysName": "EHA Custom Code System",
                 "sysVersion": "1"
             }
         ]
     },
     "valueString": "NOTE for OBSV CD ID",
     "specimenType": {
         "coding": [
             {
                 "code": "1",
                 "display": "SP1",
                 "description": "SP1Name",
                 "sysId": "EHA_CUSTOM_CD_SYS",
                 "sysName": "EHA Custom Code System",
                 "sysVersion": "1"
             }
         ]
     },
     "clinicalSpecimen": {
         "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/14212"
     },
     "patientcondition": {
         "reference": "/ohfapi/cg/v3.3/patientapi/conditions/10001"
     },
     "referenceRange": {
         "low": {
             "value": "30",
             "units": "cm",
             "code": "1",
             "description": "centi meter",
             "sysId": "1",
             "sysName": "UOM code",
             "sysVersion": "UOM version"
         },
         "high": {
             "value": "40",
             "units": "cm",
             "code": "1",
             "description": "centi meter",
             "sysId": "1",
             "sysName": "UOM code",
             "sysVersion": "UOM version"
         }
     },
     "effectiveDateTime": "12/14/1998"
 }