Concession Verification

View as Markdown
## Concession Verification Verifies whether a Medicare patient is eligible for a concession based on their identity and Medicare details. This endpoint submits patient demographic and Medicare information to the Medicare Concession Verification service and returns both a Medicare identity match status and a concession eligibility status. --- ### Request **Method:** `POST` **URL:** `{{hostURL}}/Medicare/concessionverification/v1` #### Request Body | Field | Type | Description | | --- | --- | --- | | `dateOfService` | string (date) | The date the service is being provided (ISO 8601 format). | | `patient.identity.dateOfBirth` | string (date) | Patient's date of birth (ISO 8601 format). | | `patient.identity.familyName` | string | Patient's family (last) name. | | `patient.identity.givenName` | string | Patient's given (first) name. | | `patient.identity.sex` | string | Patient's sex code (e.g. `"1"` for male). | | `patient.medicare.memberNumber` | string | Patient's Medicare card number. | | `patient.medicare.memberRefNumber` | string | Patient's Medicare card reference (line) number. | --- ### Response | Field | Description | | --- | --- | | `medicareStatus.status.code` | Medicare verification status code. Code `8017` indicates an accepted match with minor discrepancies. | | `medicareStatus.status.text` | Human-readable description of the Medicare verification result. | | `medicareStatus.currentMember.givenName` | The given name on record with Medicare (may differ from submitted name). | | `concessionStatus.status.code` | Concession eligibility code. `0` indicates the patient is eligible for concession. | | `concessionStatus.status.text` | Human-readable description of the concession eligibility result. | | `correlationId` | A unique identifier for this transaction, useful for tracing and support. | ---

Authentication

x-api-keystring
API Key authentication via header

Headers

x-minor-idstringOptional

Request

This endpoint expects an object.
patientobjectRequired
dateOfServicedateRequired

Response

OK
correlationIdstring
medicareStatusobject
concessionStatusobject