Add Patient Identifier

post

https://patient-api.portals.care/users/identifiers

Add a health card or other identifier to the patient's profile.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Add a new identifier to a patient's account. You will need to authenticate by providing the user's JWT in the Authorization header.

In the request body, you must provide the identifier's number.

Body Params

A schema for a patient's health card or insurance information. It contains details such as the card number, version code, and validity dates.

hcExp

string

The expiration date of the health card in YYYY-MM-DD format.

hcEff

string

The effective date of the health card in YYYY-MM-DD format.

hcNum

string

The health card number.

hcVer

string

The health card version code.

hcType

string

The type of health card.

uid

string

A unique identifier for the health card record.

number

string

The unique health card number. This is the primary identifier for the card.

version

string

The version code of the health card, often a two or three-character alphanumeric string.

effectiveDate

object

An object containing the effective date of the health card.

expiryDate

object

An object containing the expiration date of the health card.

type

string

enum

The type of health card.

Allowed:

groupNumber

string

The group number associated with the insurance plan, if applicable.

Headers

authorization

string

required

A Valid JWT Authentication token.

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201