Retrieve History for Patients
get
/ohfapi/cg/v3.3/patientapi/patients/history
This endpoint supports the retrieval of Histories for multiple Patient Record (row) ids passed. It returns History related information like Code, Category and other associated information.
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 : PageableCollectionHistory
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 : History
Type:
Show Source
object
-
amount(optional):
object Quantity
Model for a Quantity object in CDM.
-
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.
-
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.
-
endDate(optional):
string(date-time)
History End Date
-
familyMemberRelationshipTypeCode(optional):
object FamilyMemberRelationshipType
-
frequency(optional):
object Quantity
Model for a Quantity object in CDM.
-
identifier(optional):
object Identifier
Identifier assigned by a given system
-
lastExperienceDateTime(optional):
string(date-time)
History Last Experienced Date
-
onsetDateTime(optional):
string(date-time)
History Onset Date
-
patient(optional):
object LinkedReference
-
period(optional):
object DateRange
-
resolutionDateTime(optional):
string(date-time)
History Resolution Date
-
startDate(optional):
string(date-time)
History Start Date
-
subject(optional):
object LinkedReference
-
valueCode(optional):
object ValueCode
-
valueDateTime(optional):
string(date-time)
History Value Date
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 : 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 : FamilyMemberRelationshipType
Type:
Show Source
object
-
identifier(optional):
object CdmIdentifier
Identifier assigned by a given system
-
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 : ValueCode
Type:
Show Source
object
-
identifier(optional):
object CdmIdentifier
Identifier assigned by a given system
-
value(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 : 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
400 Response
Invalid parameters supplied
404 Response
historys not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/history?id=79&id=80
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "History", "items": [ { "identifier": { "system": "CDM", "value": "1" }, "code": { "coding": [ { "code": "9469", "display": "PH9469" } ] }, "category": { "coding": [ { "code": "PHTYPCD9469", "display": "PHTYPNM9469" } ] }, "amount": { "units": "UOM1", "code": "1" }, "frequency": { "units": "UOM1", "code": "1" }, "period": { "start": "02/11/2026", "end": "03/03/2026" }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/79" } }, { "identifier": { "system": "CDM", "value": "2" }, "code": { "coding": [ { "code": "6865", "display": "PH6865" } ] }, "category": { "coding": [ { "code": "PHTYPCD6865", "display": "PHTYPNM6865" } ] }, "frequency": { "units": "UOM1", "code": "1" }, "period": { "start": "11/26/1976", "end": "12/16/1976" }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/80" } } ], "count": 2, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/history?id=79&id=80" } ] }