Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Medications

{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId

Gets the patient medication details for the given person id, encounter id and patient medication id.

get/persons/{personId}/chart/encounters/{encounterId}/medications/{medicationId}

Path parameters

personIdstring required

(Required) (Required) The id of the patient of whose medication is being retrieved

encounterIdstring required

(Required) (Required) The id of the encounter for which the medication is being retrieved

medicationIdstring required

(Required) (Required) The id of the patient medication being retrieved

Headers

Acceptstring required

Response

OK

idstring required
fdbNamestring required
medicationNamestring required
genericNamestring required
brandNamestring required
dosestring required
doseFormstring required
ndcIdstring required
gcnstring required
routestring required
hiclSequenceNumberstring required
gcnSequenceNumberstring required
deaClassCodestring required
medicationIdstring required
isAvailablestring required
createdBystring required
createTimestampstring required
createTimestampTimezonestring required
modifiedBystring required
modifyTimestampstring required
modifyTimestampTimezonestring required
personIdstring required
encounterIdstring required
encounterProviderIdstring required
encounterTimestampstring required
encounterTimestampTimezonestring required
providerIdstring required
locationIdstring required
practiceIdstring required
practiceNamestring required
enterpriseIdstring required
enterpriseNamestring required
startDatestring required
originalStartDatestring required
stopDatestring required
sigCodesstring required
rxQuantitystring required
rxRefillsstring required
isGenericAllowedstring required
isSamplestring required
dispenseAsWrittenstring required
orgRefillsstring required
lastRefillDatestring required
sigDescriptionstring required
isPrescribedElsewherestring required
rxUnitsstring required
rxCommentstring required
rxSpecialInstructionstring required
printSpanishIndicatorstring required
isGenericSelectedstring required
diagnosisCodestring required
secondaryDiagnosisCodestring required
tertiaryDiagnosisCodestring required
representativeNdcIndicatorstring required
prnReasonstring required
formularyIdstring required
formulaOverrideCodestring required
formulaOverrideTextstring required
originalRxNdcstring required
formulaStatusstring required
auditMaskstring required
auditIdstring required
sendAuditIdstring required
lastAuditTypestring required
lotNumberstring required
expirationDatestring required
isPrnstring required
renewParentIdstring required
rxUnitCodestring required
oldIdstring required
rxRenewNotestring required
FdbDosageIdstring required
refillLimitstring required
refillLimitDatestring required
prescribedElsewhereLocationstring required
priorAuthorizationIndicatorstring required
priorAuthorizationIdstring required
priorAuthorizationDatestring required
privacyIndicatorstring required
refillsRemainingstring required
customDosageIdstring required
isAutoCalculatedstring required
pbmIdstring required
formularyDetailDatastring required
formularySummaryDatastring required
sourceProductIdstring required
supervisingProviderIdstring required
ineffectiveMedicationIndicatorstring required
pedOrderIdstring required
eCouponNotestring required
eCouponUrlstring required
auditTimestampstring required
isErxDisabledByStatestring required
isFaxDisabledByStatestring required
isHiddenstring required
isSupplystring required
rxNormCodestring required
statusstring required
rxFillIndicatorstring required

Example response

{
  "id": "<string>",
  "fdbName": "<string>",
  "medicationName": "<string>",
  "genericName": "<string>",
  "brandName": "<string>",
  "dose": "<string>",
  "doseForm": "<string>",
  "ndcId": "<string>",
  "gcn": "<string>",
  "route": "<string>",
  "hiclSequenceNumber": "<string>",
  "gcnSequenceNumber": "<string>",
  "deaClassCode": "<string>",
  "medicationId": "<string>",
  "isAvailable": "<string>",
  "createdBy": "<string>",
  "createTimestamp": "<string>",
  "createTimestampTimezone": "<string>",
  "modifiedBy": "<string>",
  "modifyTimestamp": "<string>",
  "modifyTimestampTimezone": "<string>",
  "personId": "<string>",
  "encounterId": "<string>",
  "encounterProviderId": "<string>",
  "encounterTimestamp": "<string>",
  "encounterTimestampTimezone": "<string>",
  "providerId": "<string>",
  "locationId": "<string>",
  "practiceId": "<string>",
  "practiceName": "<string>",
  "enterpriseId": "<string>",
  "enterpriseName": "<string>",
  "startDate": "<string>",
  "originalStartDate": "<string>",
  "stopDate": "<string>",
  "sigCodes": "<string>",
  "rxQuantity": "<string>",
  "rxRefills": "<string>",
  "isGenericAllowed": "<string>",
  "isSample": "<string>",
  "dispenseAsWritten": "<string>",
  "orgRefills": "<string>",
  "lastRefillDate": "<string>",
  "sigDescription": "<string>",
  "isPrescribedElsewhere": "<string>",
  "rxUnits": "<string>",
  "rxComment": "<string>",
  "rxSpecialInstruction": "<string>",
  "printSpanishIndicator": "<string>",
  "isGenericSelected": "<string>",
  "diagnosisCode": "<string>",
  "secondaryDiagnosisCode": "<string>",
  "tertiaryDiagnosisCode": "<string>",
  "representativeNdcIndicator": "<string>",
  "prnReason": "<string>",
  "formularyId": "<string>",
  "formulaOverrideCode": "<string>",
  "formulaOverrideText": "<string>",
  "originalRxNdc": "<string>",
  "formulaStatus": "<string>",
  "auditMask": "<string>",
  "auditId": "<string>",
  "sendAuditId": "<string>",
  "lastAuditType": "<string>",
  "lotNumber": "<string>",
  "expirationDate": "<string>",
  "isPrn": "<string>",
  "renewParentId": "<string>",
  "rxUnitCode": "<string>",
  "oldId": "<string>",
  "rxRenewNote": "<string>",
  "FdbDosageId": "<string>",
  "refillLimit": "<string>",
  "refillLimitDate": "<string>",
  "prescribedElsewhereLocation": "<string>",
  "priorAuthorizationIndicator": "<string>",
  "priorAuthorizationId": "<string>",
  "priorAuthorizationDate": "<string>",
  "privacyIndicator": "<string>",
  "refillsRemaining": "<string>",
  "customDosageId": "<string>",
  "isAutoCalculated": "<string>",
  "pbmId": "<string>",
  "formularyDetailData": "<string>",
  "formularySummaryData": "<string>",
  "sourceProductId": "<string>",
  "supervisingProviderId": "<string>",
  "ineffectiveMedicationIndicator": "<string>",
  "pedOrderId": "<string>",
  "eCouponNote": "<string>",
  "eCouponUrl": "<string>",
  "auditTimestamp": "<string>",
  "isErxDisabledByState": "<string>",
  "isFaxDisabledByState": "<string>",
  "isHidden": "<string>",
  "isSupply": "<string>",
  "rxNormCode": "<string>",
  "status": "<string>",
  "rxFillIndicator": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}