Retrieve Medications for a Patient
get
/ohfapi/cg/v3.3/patientapi/patients/{id}/administeredmedications
This endpoint supports the retrieval of Medications for a single Patient Record (row) id passed.
The search can further be filtered by code, name, startDate and endDate of a dateType.
The possible dateType values are SUBADMN_START_DT, SUBADMN_END_DT. It returns all the Medication related information like Encounter, Administration Type, Dosage, Code, Outcome and other Medication 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 : PageableCollectionMedication
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 Medication
Model for a Patient medication 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 : Medication
Type:
object
Model for a Patient medication object in CDM.
Show Source
-
administrationType(optional):
object AdministrationType
-
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.
-
dosage(optional):
object ValueQuantity
-
effectiveTimePeriod(optional):
object DateRange
-
encounter(optional):
object Encounter
-
identifier(optional):
object Identifier
Identifier assigned by a given system
-
outcome(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.
-
patient(optional):
object LinkedReference
-
patientcondition(optional):
object LinkedReference
-
patientProcedure(optional):
object LinkedReference
-
practitioner(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.
-
subject(optional):
object LinkedReference
Nested Schema : AdministrationType
Type:
Show Source
object
-
value(optional):
string
prescribed (P) and administered (A) drug treatments
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 : ValueQuantity
Type:
Show Source
object
-
quantity(optional):
array quantity
Read Only:
true
-
text(optional):
string
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 : 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 : quantity
Type:
array
Read Only:
Show Source
true
-
Array of:
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 : 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
Medications(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/patientapi/patients/{patientId}/administeredmedications?offset={offset}&limit&limit={limit}
Example of Response Body
The following example shows the response returned in JSON format.
{ { "resourceType": "MedicationAdministration", "items": [ { "identifier": { "system": "CDM", "value": "20001" }, "code": { "coding": [ { "code": "1", "display": "M1", "description": "M1Desc", "sysId": "RXNORM", "sysName": "RXNORM", "sysVersion": "RxNorm_full_10062014" } ] }, "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": 20001 }, "administrationType": { "value": "P" }, "effectiveTimePeriod": { "start": "01/01/1998", "end": "12/01/1998" }, "dosage": { "quantity": [ { "value": "50.1489", "units": "cm", "code": "1", "description": "centi meter", "sysId": "1", "sysName": "UOM code", "sysVersion": "UOM version" } ] }, "outcome": { "coding": [ { "code": "SUBADM_code1", "display": "SUBADM_name_1", "description": "SUBADM_desc_", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] }, "practitioner": { "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" } ] }, "speciality": { "coding": [ { "code": "Speciality_1", "display": "SP_LTY_NAME", "description": "SP_LTY_DESC", "sysId": "EHA_CUSTOM_CD_SYS", "sysName": "EHA Custom Code System", "sysVersion": "1" } ] } }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/patients/3" } } ], "count": 1, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/administeredmedications?offset=0&limit=1&id=3&id=4" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/administeredmedications?offset=1&limit=1&id=3&id=4" } ] }