Jump to

• Request
• Response

Get a medication by ID

get

/Medication/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual medication by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Medication

Type: object

A medication identified by terminology coding or a compound ingredient list.

Show Source

• code(required): object CodeableConcept
• id(required): string
  The logical ID of the medication.
• ingredient: array ingredient
  The medication components for a compound medication.
• meta: object meta
• resourceType(required): string
  Allowed Values: [ "Medication" ]
• text(required): object Narrative

{
    "type":"object",
    "description":"A medication identified by terminology coding or a compound ingredient list.",
    "required":[
        "resourceType",
        "id",
        "text",
        "code"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Medication"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the medication."
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string",
                    "description":"The version-specific identifier."
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The last update time."
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "ingredient":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IngredientForMedication"
            },
            "description":"The medication components for a compound medication."
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : ingredient

Type: array

The medication components for a compound medication.

Show Source

• Array of: object IngredientForMedication

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IngredientForMedication"
    },
    "description":"The medication components for a compound medication."
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
  The last update time.
• security: array security
• versionId: string
  The version-specific identifier.

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string",
            "description":"The version-specific identifier."
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The last update time."
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : IngredientForMedication

Type: object

Show Source

• itemReference(required): object ReferenceForMedication

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "itemReference"
    ],
    "properties":{
        "itemReference":{
            "$ref":"#/components/schemas/ReferenceForMedication"
        }
    }
}

Nested Schema : ReferenceForMedication

Type: object

Show Source

• display: string
  The human-readable ingredient name.
• reference(required): string
  The relative medication reference.
• type(required): string
  Allowed Values: [ "Medication" ]

  The referenced resource type.

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "reference",
        "type"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "description":"The relative medication reference."
        },
        "type":{
            "type":"string",
            "enum":[
                "Medication"
            ],
            "description":"The referenced resource type."
        },
        "display":{
            "type":"string",
            "description":"The human-readable ingredient name."
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top