Jump to

• Request
• Response
• Examples

Retrieve Medication for a Medication Identifier

get

/ohfapi/cg/v3.3/patientapi/administeredmedications/{id}

This endpoint supports the retrieval of Medication for a single Medication Identifier. It returns the medication linked to the identifier.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: integer(int64)
  Minimum Value: 0

  Medication Row ID

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root 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

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Identifier information for this record.",
            "$ref":"#/definitions/Identifier"
        },
        "code":{
            "description":"The medication that is administered to the patient.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "encounter":{
            "description":"encounter information",
            "$ref":"#/definitions/Encounter"
        },
        "administrationType":{
            "description":"Substance administration status is used to identify prescribed (P) and administered (A) drug treatments.",
            "$ref":"#/definitions/AdministrationType"
        },
        "effectiveTimePeriod":{
            "description":"The start and end date time of the administration of the substance.",
            "$ref":"#/definitions/DateRange"
        },
        "dosage":{
            "description":"Quantity details of the administration given.",
            "$ref":"#/definitions/ValueQuantity"
        },
        "outcome":{
            "description":"The outcome that is associated with the substance administration.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "practitioner":{
            "description":"The practitioner / service provider that performed the the medication administration.",
            "$ref":"#/definitions/Practitioner"
        },
        "subject":{
            "description":"reference link to the subject",
            "$ref":"#/definitions/LinkedReference"
        },
        "patient":{
            "description":"reference link to the patient",
            "$ref":"#/definitions/LinkedReference"
        },
        "patientcondition":{
            "example":"{href: '/patientapi/conditions/{conditionId}'}",
            "description":"A link containing href to retrieve Condition details associated with this medication",
            "$ref":"#/definitions/LinkedReference"
        },
        "patientProcedure":{
            "example":"{href: '/patientapi/procedures/{procedureId}'}",
            "description":"A link containing href to retrieve the Procedure details associated with this medication",
            "$ref":"#/definitions/LinkedReference"
        }
    },
    "description":"Model for a Patient medication object in CDM."
}

Nested Schema : AdministrationType

Type: object

Show Source

• value(optional): string
  prescribed (P) and administered (A) drug treatments

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"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.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Plain text representation of the concept."
        },
        "coding":{
            "type":"array",
            "description":"Code(s) defined by a terminology system.",
            "readOnly":true,
            "items":{
                "xml":{
                    "name":"coding"
                },
                "$ref":"#/definitions/Coding"
            }
        }
    },
    "description":"Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text."
}

Nested Schema : ValueQuantity

Type: object

Show Source

• quantity(optional): array quantity
  Read Only: true
• text(optional): string

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "quantity":{
            "type":"array",
            "readOnly":true,
            "items":{
                "xml":{
                    "name":"quantity"
                },
                "$ref":"#/definitions/Quantity"
            }
        }
    }
}

Nested Schema : DateRange

Type: object

Show Source

• end(optional): string(date-time)
• start(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : Encounter

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"Encounter type information for this encounter. Details such as encounter type code, name , description.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "location":{
            "description":"The location or facility details of the encounter.",
            "$ref":"#/definitions/Location"
        },
        "sequence":{
            "description":"The sequence or priority of the event within an encounter e.g. 1, 2 etc.",
            "$ref":"#/definitions/Number"
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "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.

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.

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Healthcare service provider system identifier. It can include a service provider Row ID value or service provider unique identifier.",
            "$ref":"#/definitions/CdmIdentifier"
        },
        "type":{
            "description":"The healthcare practitioner type or role, i.e. type/role code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "name":{
            "description":"A name associated with the person.",
            "$ref":"#/definitions/HumanName"
        },
        "telecom":{
            "description":"A contact detail for the practitioner. For example, the telephone number, email, or fax.",
            "$ref":"#/definitions/Telecom"
        },
        "address":{
            "description":"Where practitioner can be found/visited.",
            "$ref":"#/definitions/Address"
        },
        "speciality":{
            "description":"Detaile of the specific specialty of the practitioner, i.e. specialty code, name, description etc.",
            "$ref":"#/definitions/CodeableConcept"
        },
        "specimenAliasIssuerFlag":{
            "type":"string",
            "description":"The flag that indicates that this Service Provider has issued Specimen Alias(es)."
        }
    },
    "description":"Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility."
}

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.

{
    "type":"array",
    "description":"Code(s) defined by a terminology system.",
    "readOnly":true,
    "items":{
        "xml":{
            "name":"coding"
        },
        "$ref":"#/definitions/Coding"
    }
}

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.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Symbol in syntax defined by the system."
        },
        "display":{
            "type":"string",
            "description":"Representation defined by the system."
        },
        "description":{
            "type":"string",
            "description":"Description defined by the system."
        },
        "sysId":{
            "type":"string",
            "description":"Identity of the terminology system."
        },
        "sysName":{
            "type":"string",
            "description":"Name of the terminology system."
        },
        "sysVersion":{
            "type":"string",
            "description":"Version of the system - if relevant."
        },
        "srvcProviderId":{
            "type":"string",
            "description":"Service Provider Id of Specimen Alias ."
        },
        "srvcProviderName":{
            "type":"string",
            "description":"Service Provider Name of Specimen Alias ."
        }
    },
    "description":"Model for a reference to a code defined by a terminology system."
}

Nested Schema : quantity

Type: array

Read Only: true

Show Source

• Array of: object Quantity
  Model for a Quantity object in CDM.

{
    "type":"array",
    "readOnly":true,
    "items":{
        "xml":{
            "name":"quantity"
        },
        "$ref":"#/definitions/Quantity"
    }
}

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.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"The numerical value of the quantity."
        },
        "units":{
            "type":"string",
            "description":"The quantity units displayable name."
        },
        "code":{
            "type":"string",
            "description":"The quantity units symbol in syntax defined by the system."
        },
        "description":{
            "type":"string",
            "description":"The quantity units description."
        },
        "sysId":{
            "type":"string",
            "description":"The quantity units terminology system identifier."
        },
        "sysName":{
            "type":"string",
            "description":"The quantity units terminology system name."
        },
        "sysVersion":{
            "type":"string",
            "description":"The quantity units terminology system version."
        }
    },
    "description":"Model for a Quantity object in CDM."
}

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

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : Location

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "identifier":{
            "$ref":"#/definitions/CdmIdentifier"
        },
        "name":{
            "type":"string",
            "description":"Name of the facility."
        },
        "type":{
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

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.

{
    "type":"object",
    "properties":{
        "line":{
            "type":"array",
            "description":"Street name, number, direction & P.O. Box etc.",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string",
            "description":"Name of city, town etc."
        },
        "district":{
            "type":"string",
            "description":"District name (aka county)."
        },
        "state":{
            "description":"Sub-unit of country (abbreviations ok).",
            "$ref":"#/definitions/CodeableConcept"
        },
        "postalCode":{
            "type":"string",
            "description":"Postal code for area."
        },
        "country":{
            "description":"Country (can be ISO 3166 3 letter code).",
            "$ref":"#/definitions/CodeableConcept"
        }
    },
    "description":"Model for a postal address."
}

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.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Text representation of the full name."
        },
        "family":{
            "type":"string",
            "description":"Family name (often called 'Surname')."
        },
        "given":{
            "type":"array",
            "description":"Given names (not always 'first'). Includes middle names.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for a name of a human with text and parts information."
}

Nested Schema : Telecom

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Telecom Value"
        },
        "use":{
            "description":"Telecom Use CodeableConcept Details",
            "$ref":"#/definitions/CodeableConcept"
        }
    }
}

Nested Schema : line

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "description":"Street name, number, direction & P.O. Box etc.",
    "items":{
        "type":"string"
    }
}

Nested Schema : given

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "description":"Given names (not always 'first'). Includes middle names.",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid parameters supplied

404 Response

Medication not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/administeredmedications/10004

Example of Response Body

The following example shows the response returned in JSON format.

{
     "identifier": {
         "system": "CDM",
         "value": "10004"
     },
     "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": 10004
     },
     "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/2"
     },
     "patientcondition": {
         "reference": "/ohfapi/cg/v3.3/patientapi/conditions/10001"
     }
 }

Back to Top