Retrieve Clinical Encounters for a Patient
get
/ohfapi/cg/v3.3/patientapi/patients/{id}/encounters
This endpoint supports the retrieval of Clinical Encounters for a single Patient Record (row) id passed.
The data can be filtered by code, name, startDate and endDate of dateType (ENCOUNTER_START_DT ,ENCOUNTER_END_DT). It returns Clinical Encounter information like Type, Encounter Number, Location and other Clinical Encounter associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
Patient Row ID
Query Parameters
-
code(optional): string
Clinical Filter query params: ?code=DCode&name=DName
-
dateType(optional): string
Clinical Filter query params: ?code=DCode&name=DName
-
endDate(optional): string
Clinical Filter query params: ?code=DCode&name=DName
-
limit(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
-
name(optional): string
Clinical Filter query params: ?code=DCode&name=DName
-
offset(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
-
startDate(optional): string
Clinical Filter query params: ?code=DCode&name=DName
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollectionClinicalEncounter
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 : items
Type:
array
A collection of paged items.
Show Source
-
Array of:
object ClinicalEncounter
Model for a clinical encounter object in CDM.
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 : ClinicalEncounter
Type:
object
Model for a clinical encounter object in CDM.
Show Source
-
drgCode(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.
-
encounterNumber(optional):
string
Encounter Number
-
identifier(optional):
object Identifier
Identifier assigned by a given system
-
location(optional):
object Location
-
patient(optional):
object LinkedReference
-
period(optional):
object DateRange
-
subject(optional):
object LinkedReference
-
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 : 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 : 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 : 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 : 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
Encounter(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/1/encounters?limit=2&offset=0
Example of Response Body
The following example shows the response returned in JSON format.
{ "resourceType": "Encounter", "items": [ { "identifier": { "system": "CDM", "value": "1" }, "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" } ] } }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/1" }, "period": { "start": "01/01/1998", "end": "12/01/1998" }, "encounterNumber": "ENC1" }, { "identifier": { "system": "CDM", "value": "2" }, "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" } ] } }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/1" }, "period": { "start": "01/01/1998", "end": "12/01/1998" }, "encounterNumber": "ENC1" } ], "count": 2, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/1/encounters?limit=2&offset=0" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/1/encounters?offset=2&limit=2" } ] }