Retrieve Observations for a Patient Identifier
get
/HSDataService-web/api/3.2.0/patientapi/patients/{id}/observations
This endpoint supports the retrieval of Observations for a single Patient Identifier 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
Path Parameters
- id
-
Type:
integer
(int64
)Required:true
Patient Row ID
Query Parameters
- limit
-
Type:
integer
(int32
)Pagination query params: ?limit=2&offset=0- offset
Type:integer
(int32
)Pagination query params: ?limit=2&offset=0
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Body
Model for paginated collections of data.
Root Schema : PageableCollectionObservation
Type:
object
Model for paginated collections of data.
- count
-
Type:
integer
(int64
)Number of objects in the 'items' collection. - hasMore
-
Type:
boolean
Default Value:false
A boolean indicating if more pages are available. - items
-
Type:
array
itemsA collection of paged items. - links
-
Type:
array
linksA collection of links containing hrefs to the current, next, and previous pages as applicable. - resourceType
-
Type:
string
Identify the resource type
Nested Schema : items
Nested Schema : links
Nested Schema : Observation
Type:
object
- bodySite
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - category
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - code
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - effectiveDateTime
-
Type:
string
(date-time
)Effective Date - encounter
-
Type:
object
Encounter - identifier
-
Type:
object
IdentifierIdentifier assigned by a given system - patient
-
Type:
object
LinkedReference - performer
-
Type:
object
PractitionerModel for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility. - referenceRange
-
Type:
object
ReferenceRange - specimenType
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - subject
-
Type:
object
LinkedReference - valueCodeableConcept
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - valueQuantity
-
Type:
object
QuantityModel for a Quantity object in CDM. - valueString
-
Type:
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.
- coding
-
Type:
array
codingRead Only:true
Code(s) defined by a terminology system. - text
-
Type:
string
Plain text representation of the concept.
Nested Schema : Encounter
Type:
object
- identifier
-
Type:
object
CdmIdentifierIdentifier assigned by a given system - location
-
Type:
object
Location - sequence
-
Type:
object
Number - type
-
Type:
object
CodeableConceptModel 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
- system
-
Type:
string
System which assigned this identifier - value
-
Type:
string
Identifier value
Nested Schema : LinkedReference
Type:
object
- display
-
Type:
string
- reference
-
Type:
string
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.
- address
-
Type:
object
AddressModel for a postal address. - identifier
-
Type:
object
CdmIdentifierIdentifier assigned by a given system - name
-
Type:
object
HumanNameModel for a name of a human with text and parts information. - speciality
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - specimenAliasIssuerFlag
-
Type:
string
The flag that indicates that this Service Provider has issued Specimen Alias(es). - telecom
-
Type:
object
Telecom - type
-
Type:
object
CodeableConceptModel 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:
object
Nested Schema : Quantity
Type:
object
Model for a Quantity object in CDM.
- code
-
Type:
string
The quantity units symbol in syntax defined by the system. - description
-
Type:
string
The quantity units description. - sysId
-
Type:
string
The quantity units terminology system identifier. - sysName
-
Type:
string
The quantity units terminology system name. - sysVersion
-
Type:
string
The quantity units terminology system version. - units
-
Type:
string
The quantity units displayable name. - value
-
Type:
string
The numerical value of the quantity.
Nested Schema : coding
Nested Schema : Coding
Type:
object
Model for a reference to a code defined by a terminology system.
- code
-
Type:
string
Symbol in syntax defined by the system. - description
-
Type:
string
Description defined by the system. - display
-
Type:
string
Representation defined by the system. - sysId
-
Type:
string
Identity of the terminology system. - sysName
-
Type:
string
Name of the terminology system. - sysVersion
-
Type:
string
Version of the system - if relevant.
Nested Schema : CdmIdentifier
Type:
object
Identifier assigned by a given system
- system
-
Type:
string
System which assigned this identifier - value
-
Type:
string
Identifier value
Nested Schema : Location
Type:
object
- identifier
-
Type:
object
CdmIdentifierIdentifier assigned by a given system - name
-
Type:
string
Name of the facility. - type
-
Type:
object
CodeableConceptModel 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.
- city
-
Type:
string
Name of city, town etc. - country
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - district
-
Type:
string
District name (aka county). - line
-
Type:
array
lineStreet name, number, direction & P.O. Box etc. - postalCode
-
Type:
string
Postal code for area. - state
-
Type:
object
CodeableConceptModel 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.
- family
-
Type:
string
Family name (often called 'Surname'). - given
-
Type:
array
givenGiven names (not always 'first'). Includes middle names. - text
-
Type:
string
Text representation of the full name.
Nested Schema : Telecom
Type:
object
- use
-
Type:
object
CodeableConceptModel that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text. - value
-
Type:
string
Telecom Value
Nested Schema : line
Nested Schema : given
400 Response
Invalid parameters supplied
404 Response
Observation(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/1/observations?limit=10&offset=0
Example of Response Body
The following example shows the response returned 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": "/HSDataService-web/api/3.2.0/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": "/HSDataService-web/api/3.2.0/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": "/HSDataService-web/api/3.2.0/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": "/HSDataService-web/api/3.2.0/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": 2, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/1/observations?limit=2&offset=0" }, { "rel": "next", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/1/observations?offset=2&limit=2" } ] }