REST API for Oracle Healthcare Translational Research

Retrieve Medications for a Subject Identifier

get

/HSDataService-web/api/3.2.0/subjectapi/subjects/{id}/administeredmedications

This endpoint supports the retrieval of Medications for a single Subject Identifier passed. 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: Type: integer (int64)

Required: true

Subject 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 : PageableCollectionMedication

Type: object

Model for paginated collections of data.

Properties

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 items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: 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.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested Schema : Medication

Type: object

Model for a Patient medication object in CDM.

Properties

administrationType: Type: object AdministrationType
code: Type: 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: Type: object ValueQuantity
effectiveTimePeriod: Type: object DateRange
encounter: Type: object Encounter
identifier: Type: object Identifier

Identifier assigned by a given system
outcome: Type: 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: Type: object LinkedReference
practitioner: Type: 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: Type: object LinkedReference

Nested Schema : AdministrationType

Type: object

Properties

value: Type: 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.

Properties

coding: Type: array coding

Read Only: true

Code(s) defined by a terminology system.
text: Type: string

Plain text representation of the concept.

Nested Schema : ValueQuantity

Type: object

Properties

quantity: Type: array quantity

Read Only: true
text: Type: string

Nested Schema : DateRange

Type: object

Properties

end: Type: string (date-time)
start: Type: string (date-time)

Nested Schema : Encounter

Type: object

Properties

identifier: Type: object CdmIdentifier

Identifier assigned by a given system
location: Type: object Location
sequence: Type: object Number
type: Type: 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

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

Nested Schema : LinkedReference

Type: object

Properties

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.

Properties

address: Type: object Address

Model for a postal address.
identifier: Type: object CdmIdentifier

Identifier assigned by a given system
name: Type: object HumanName

Model for a name of a human with text and parts information.
speciality: Type: 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: Type: string

The flag that indicates that this Service Provider has issued Specimen Alias(es).
telecom: Type: object Telecom
type: Type: 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.

Items

Type: 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.

Properties

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 : quantity

Type: array

Read Only: true

Items

Type: object Quantity

Model for a Quantity object in CDM.

Nested Schema : Quantity

Type: object

Model for a Quantity object in CDM.

Properties

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 : CdmIdentifier

Type: object

Identifier assigned by a given system

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

Nested Schema : Location

Type: object

Properties

identifier: Type: object CdmIdentifier

Identifier assigned by a given system
name: Type: string

Name of the facility.
type: Type: 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.

Properties

city: Type: string

Name of city, town etc.
country: Type: 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: Type: string

District name (aka county).
line: Type: array line

Street name, number, direction & P.O. Box etc.
postalCode: Type: string

Postal code for area.
state: Type: 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.

Properties

family: Type: string

Family name (often called 'Surname').
given: Type: array given

Given names (not always 'first'). Includes middle names.
text: Type: string

Text representation of the full name.

Nested Schema : Telecom

Type: object

Properties

use: Type: 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: Type: string

Telecom Value

Nested Schema : line

Type: array

Street name, number, direction & P.O. Box etc.

Items

Type: string

Nested Schema : given

Type: array

Given names (not always 'first'). Includes middle names.

Items

Type: string

400 Response

Invalid parameters supplied

404 Response

Medications(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects/1/administeredmedications?limit=5&offset=0

Example of Response Body

The following example shows the response returned in JSON format.

  {
        "resourceType": "MedicationAdministration",
        "items":
        [
            {
                "identifier":
                {
                    "system": "CDM",
                    "value": "1"
                },
                "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": 1
                },
                "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"
                            }
                        ]
                    }
                },
                "subject":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1"
                },
                "patient":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/patients"
                }
            },
            {
                "identifier":
                {
                    "system": "CDM",
                    "value": "2"
                },
                "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": 2
                },
                "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"
                            }
                        ]
                    }
                },
                "subject":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1"
                },
                "patient":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/patients"
                }
            },
            {
                "identifier":
                {
                    "system": "CDM",
                    "value": "3"
                },
                "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": 3
                },
                "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"
                            }
                        ]
                    }
                },
                "subject":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1"
                },
                "patient":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/patients"
                }
            },
            {
                "identifier":
                {
                    "system": "CDM",
                    "value": "4"
                },
                "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": 4
                },
                "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"
                            }
                        ]
                    }
               },
                "subject":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1"
                },
                "patient":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/patients"
                }
            },
            {
                "identifier":
                {
                    "system": "CDM",
                    "value": "5"
                },
                "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": 5
               },
                "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"
                            }
                        ]
                    }
                },
                "subject":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1"
                },
                "patient":
                {
                    "reference": "/HSDataService-web/api/3.2.0/subjectapi/subjects/1/patients"
                }
            }
        ],
        "count": 5,
        "hasMore": true,
        "links":
        [
            {
                "rel": "self",
                "href": "http://localhost:7001/HSDataService-eb/api/3.2.0/subjectapi/subjects/1/administeredmedications?limit=5&offset=0"
            },
            {
                "rel": "next",
                "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects/1/administeredmedications?offset=5&limit=5"
            }
        ]
    }