HDR FHIR API

GET MedicationKnowledge Resource Bundle

get

/oracle-fhir-server/fhir/MedicationKnowledge

This endpoint supports the retrieval of MedicationKnowledge resource list.It returns Bundle of MedicationKnowledge resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
classification(optional): string

Specific category assigned to the medication
classification-type(optional): string

The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
code(optional): string

Code that identifies this medication
doseform(optional): string

powder | tablets | capsule +
ingredient(optional): string

Medication(s) or substance(s) contained in the medication
ingredient-code(optional): string

Medication(s) or substance(s) contained in the medication
manufacturer(optional): string

Manufacturer of the item
monitoring-program-name(optional): string

Name of the reviewing program
monitoring-program-type(optional): string

Type of program under which the medication is monitored
monograph(optional): string

Associated documentation about the medication
monograph-type(optional): string

The category of medication document
source-cost(optional): string

The source or owner for the price information
status(optional): string

active | inactive | entered-in-error

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object MedicationKnowledge

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MedicationKnowledge"
    }
}

Nested Schema : MedicationKnowledge

Type: object

Show Source

amount: object MedicationKnowledge_amount
code: object ActivityDefinition_valueCodeableConcept
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
doseForm: object ActivityDefinition_valueCodeableConcept
id: string

Minimum Length: 1
manufacturer: object Account_coverage
meta: object Account_meta
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
synonym: array synonym
text: object Account_text

{
    "type":"object",
    "required":[
        "amount",
        "code",
        "contained",
        "doseForm",
        "id",
        "manufacturer",
        "meta",
        "resourceType",
        "status",
        "synonym",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/MedicationKnowledge_contained"
            },
            "minItems":1
        },
        "code":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "manufacturer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "doseForm":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "amount":{
            "$ref":"#/definitions/MedicationKnowledge_amount"
        },
        "synonym":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : MedicationKnowledge_amount

Type: object

Show Source

unit: string

Minimum Length: 1
value: number

{
    "required":[
        "unit",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : contained

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object MedicationKnowledge_contained

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/MedicationKnowledge_contained"
    },
    "minItems":1
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : synonym

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : MedicationKnowledge_contained

Type: object

Show Source

id: string

Minimum Length: 1
name: string

Minimum Length: 1
resourceType: string

Minimum Length: 1

{
    "required":[
        "id",
        "name",
        "resourceType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}