Retrieve Observations for Patients
get
/ohfapi/cg/v3.3/patientapi/observations
This endpoint supports the retrieval of Observations for multiple Patient Record (row) ids passed. It returns all the Observation related information like Code, Name, Type, Value, Encounter, Facility and Service Provider.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
id: array
Collection Format:
multi
Minimum Number of Items:1
Maximum Number of Items:2147483647
Patient Identifiers -
limit(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
-
offset(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollectionObservation
Type:
object
Model for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
A boolean indicating if more pages are available.
-
items(optional):
array items
A collection of paged items.
-
links(optional):
array links
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : links
Type:
array
A collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}
Nested Schema : Observation
Type:
Show Source
object
-
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
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.
Nested Schema : Encounter
Type:
Show Source
object
-
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.
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
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.
Nested Schema : ReferenceRange
Type:
Show Source
object
-
high(optional):
object Quantity
Model for a Quantity object in CDM.
-
low(optional):
object Quantity
Model for a Quantity object in CDM.
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.
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.
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.
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
Nested Schema : Location
Type:
Show Source
object
-
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.
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.
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.
Nested Schema : Telecom
Type:
Show Source
object
-
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
Nested Schema : given
Type:
array
Given names (not always 'first'). Includes middle names.
Show Source
400 Response
Invalid parameters supplied
404 Response
Observation(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/patientapi/observations?id=1&id=2&id=3&id=4&limit=5&offset=0
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "Observation", "items": [ { "identifier": { "system": "CDM", "value": "1" }, "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/1" }, "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": 1 }, "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", "specimen": { "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/1" }, "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" }, { "identifier": { "system": "CDM", "value": "2" }, "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/1" }, "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": 2 }, "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", "specimen": { "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/1" }, "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" }, { "identifier": { "system": "CDM", "value": "3" }, "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/1" }, "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": 3 }, "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", "specimen": { "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/1" }, "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" }, { "identifier": { "system": "CDM", "value": "4" }, "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/1" }, "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": 4 }, "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", "specimen": { "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/1" }, "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" }, { "identifier": { "system": "CDM", "value": "5" }, "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/1" }, "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": 5 }, "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", "specimen": { "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/1" }, "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" } ], "count": 5, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/observations?id=1&id=2&id=3&id=4&limit=5&offset=0" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/observations?offset=5&limit=5&id=1&id=2&id=3&id=4" } ] }