User Tools

Site Tools


JSON Schema

Schema: https://rximage.nlm.nih.gov/rxImageAccess.json

{
    "$schema": "https://json-schema.org/draft-04/schema#",
    "title": "rxImageAccess",
    "description": "A query response from Medicos Consultants, LLC's rxImage API",
    "type": "object",
    "required": true,
    "properties": {
        "replyStatus": {
            "type":"object",
            "required":true,
            "properties":{
                "success": {
                    "type":"boolean",
                    "required":true
                },
                "errorCode": {
                    "type":"integer",
                    "required":false
                },
                "errorMsg": {
                    "type":"string",
                    "required":false
                },
                "imageCount": {
                    "type":"integer",
                    "required":false
                },
                "totalImageCount": {
                    "type":"integer",
                    "required":false
                },
                "pageNumber": {
                    "type":"integer",
                    "required":false
                },
                "totalPageCount": {
                    "type":"integer",
                    "required":false
                },
                "date": {
                    "type":"string",
                    "required":true
                },
                "matchedTerms": {
                    "type": "object",
                    "properties": {
                        "ndc": {
                            "type": "string",
                            "required":false
                        },
                        "id": {
                            "type": "string",
                            "required":false
                        },
                        "setId": {
                            "type": "string",
                            "required":false
                        },
                        "rootId": {
                            "type": "string",
                            "required":false
                        },
                        "imprint": {
                            "type": "string",
                            "required":false
                        },
                        "rxcui": {
                            "type": "string",
                            "required":false
                        },
                        "shape": {
                            "type": "string",
                            "required":false
                        },
                        "color": {
                            "type": "string",
                            "required":false
                        },
                        "symbol": {
                            "type": "string",
                            "required":false
                        },
                        "size": {
                            "type": "string",
                            "required":false
                        },
                        "score": {
                            "type": "string",
                            "required":false
                        },
                        "imprintColor": {
                            "type": "string",
                            "required":false
                        },
                        "imprintType": {
                            "type": "string",
                            "required":false
                        },
                        "name": {
                            "type": "string",
                            "required":false
                        },
                        "inactive": {
                            "type": "string",
                            "required":false
                        }
                    }
                }
            }
        },
        "nlmRxImages": {
            "type":"array",
            "required":false,
            "items": {
                "type":"object",
                "required":true,
                "properties":{
                    "id": {
                        "type":"integer",
                        "required":true
                    },
                    "ndc11": {
                        "type":"string",
                        "required":true
                    },
                    "part": {
                        "type":"integer",
                        "required":true
                    },
                    "matchNdc": {
                        "type":"string",
                        "required":false
                    },
                    "relabelersNdc9": {
                        "type":"array",
                        "required":false,
                        "items": {
                            "type":"object",
                            "required":false,
                            "properties":{
                                "@sourceNdc9": {
                                    "type":"string",
                                    "required":false
                                },
                                "ndc9": {
                                    "type":"array",
                                    "required":false,
                                    "items": {
                                        "type":"string",
                                        "required":true
                                    }
                                }
                            }
                        }
                    },
                    "status": {
                        "type":"string",
                        "required":false
                    },
                    "rxcui": {
                        "type":"integer",
                        "required":true
                    },
                    "splSetId": {
                        "type":"string",
                        "required":false
                    },
                    "splRootId": {
                        "type":"string",
                        "required":false
                    },
                    "splVersion": {
                        "type":"integer",
                        "required":false
                    },
                    "acqDate": {
                        "type":"string",
                        "required":false
                    },
                    "name": {
                        "type":"string",
                        "required":true
                    },
                    "labeler": {
                        "type":"string",
                        "required":true
                    },
                    "deaSchedule": {
                        "type":"string",
                        "required":false
                    },
                    "imageUrl": {
                        "type":"string",
                        "required":true
                    },
                    "imageSize": {
                        "type":"integer",
                        "required":true
                    },
                    "attribution": {
                        "type":"string",
                        "required":true
                    },
                    "ingredientsAvailable": {
                        "type":"boolean",
                        "required":false
                    },
                    "ingredients": {
                        "type":"object",
                        "required":false,
                        "properties":{
                            "active": {
                                "type":"array",
                                "required":false,
                                "items": {
                                    "type":"string",
                                    "required":false
                                }
                            },
                            "inactive": {
                                "type":"array",
                                "required":false,
                                "items": {
                                    "type":"string",
                                    "required":false
                                }
                            }
                        }
                    },
                    "mpc": {
                        "type":"object",
                        "required":false,
                        "properties":{
                            "color": {
                                "type":"string",
                                "required":false
                            },
                            "imprintColor": {
                                "type":"string",
                                "required":false
                            },
                            "imprintType": {
                                "type":"string",
                                "required":false
                            },
                            "imprint": {
                                "type":"string",
                                "required":false
                            },
                            "score": {
                                "type":"integer",
                                "required":false
                            },
                            "shape": {
                                "type":"string",
                                "required":false
                            },
                            "size": {
                                "type":"integer",
                                "required":false
                            },
                            "symbol": {
                                "type":"boolean",
                                "required":false
                            }
                        }
                    }
                }
            }
        },
        "enum": {
            "type": "object",
            "required": false,
            "properties": {
                "color": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "shape": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "size": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "score": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "imprintType": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "imprintColor": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "collectionName": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "resolution": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                },
                "version": {
                    "type": "array",
                    "required": false,
                    "items": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "name": {
                            "type": "string",
                            "required": true
                            },
                            "description": {
                            "type": "string",
                            "required": false
                            }
                        }
                    }
                }
            }
        }
    }
}

Page Tools