Calls made at Identify. Taught at /rail/stops/Identify.
List the identifier types a desk may choose, spelled as the lookup takes them.
List the identifier types a desk may choose, spelled as the lookup takes them.
Public: it needs no token and no facility headers. Each code is exactly what the lookup takes as identifier.type, so send it back as returned; any other spelling comes back from the lookup as 404 MEMBER_NOT_FOUND. PAYER_MEMBER_NO is the one type that also needs a payer: pick it from the payers list. Cache the list; never embed it.
Keep from the response: results[].code
Taught in: 01 · Identify
List the identifier types a desk may choose, spelled as the lookup takes them. › Responses
Returns results[].code.
catalogsystemcountpagepage_sizetotal_pageshas_nexthas_previousList the insurers a payer member number can be issued by.
List the insurers a payer member number can be issued by.
A payer's member number is only unique within the insurer that issued it, so a lookup by PAYER_MEMBER_NO must say which insurer. Send the chosen code as identifier.payer_slade_code on the lookup. The list is read from the payors value set and cached for 24 hours. 502 or 503 PAYERS_UNAVAILABLE means the list could not be read, which is not the same as there being no payers: retry rather than showing an empty picker. Cache the list; never embed it.
Keep from the response: payers[].code
Taught in: 01 · Identify
List the insurers a payer member number can be issued by. › Responses
Returns payers[].code.
countResolve an identifier pair to one unique_patient_id, with masked details to confirm the human.
Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human.
identifier.type is a code from the identifier-types list, sent as returned. A payer member number (PAYER_MEMBER_NO) is only unique within the insurer that issued it, so that type also takes identifier.payer_slade_code, a code from the payers list; the other types do not.
Keep from the response: unique_patient_id
Taught in: 01 · Identify
Headers
X-Facility-IdThe facility this call is made from.
X-Facility-Id-TypeHow to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.
Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Request Body
Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Responses
Returns unique_patient_id.
lookup_refunique_patient_idRead unredacted identity and household for one patient.
Read unredacted identity and household for one patient.
Includes contacts and dependents. Released only against a verified pii_access consent.
Keep from the response: dependents[].unique_patient_id
Taught in: 01 · Identify
path Parameters
unique_patient_idunique patient id
query Parameters
consent_refA verified, unexpired pii_access consent for this patient. Verified, not spent: it can be read again.
Headers
X-Facility-IdThe facility this call is made from.
X-Facility-Id-TypeHow to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.
Read unredacted identity and household for one patient. › Responses
Returns dependents[].unique_patient_id.
unique_patient_idfull_namedate_of_birthgenderregistered_onLook up one practitioner in the health worker registry.
Look up one practitioner in the health worker registry.
Returns the practitioner as the registry holds them. Read the licence dates yourself.
Keep from the response: message.licenses[].license_end
Taught in: 01 · Identify
query Parameters
identification_numberpractitioner license
identification_typeidentification type
regulatorregulator
Look up one practitioner in the health worker registry. › Responses
Returns message.licenses[].license_end.

