HealthID

@Serializable
data class HealthID(val healthInsuranceId: String? = null, val patientId: String? = null, val taxNumber: String? = null, val oneTimeToken: String? = null, val ePrescriptionCode: String? = null, val affiliationCountry: String? = null, val issueDate: Instant, val expiryDate: Instant, val issuingAuthority: String, val documentNumber: String? = null, val administrativeNumber: String? = null, val issuingCountry: String, val issuingJurisdiction: String? = null)(source)

Constructors

Link copied to clipboard
constructor(healthInsuranceId: String? = null, patientId: String? = null, taxNumber: String? = null, oneTimeToken: String? = null, ePrescriptionCode: String? = null, affiliationCountry: String? = null, issueDate: Instant, expiryDate: Instant, issuingAuthority: String, documentNumber: String? = null, administrativeNumber: String? = null, issuingCountry: String, issuingJurisdiction: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "administrative_number")
val administrativeNumber: String? = null

A number assigned by the Health ID attestation Provider for audit control or other purposes.

Link copied to clipboard
@SerialName(value = "affiliation_country")
val affiliationCountry: String? = null

Alpha-2 country code, as defined in ISO 3166-1, of the user’s country of tax residence of affiliation as used in the international search mask

Link copied to clipboard
@SerialName(value = "document_number")
val documentNumber: String? = null

A number for the Health ID attestation, assigned by the Provider.

Link copied to clipboard
@SerialName(value = "wallet_e_prescription_code")
val ePrescriptionCode: String? = null

Character string that enables the health care provider to identify the person via international search mask (national format). Contains TaskID, Access Code and human readable part separated with a | (pipe char)

Link copied to clipboard
@SerialName(value = "expiry_date")
val expiryDate: Instant

Date and time when the Health ID attestation will expire.

Link copied to clipboard
@SerialName(value = "health_insurance_id")
val healthInsuranceId: String? = null

Character string that enables the health care provider to identify the person via international search mask (national format)

Link copied to clipboard
@SerialName(value = "issue_date")
val issueDate: Instant

Date and time when the Health ID attestation was issued.

Link copied to clipboard
@SerialName(value = "issuing_authority")
val issuingAuthority: String

Name of the administrative authority that has issued this Health ID attestation, or the ISO 3166 Alpha-2 country code of the respective Member State if there is no separate authority authorized to issue health insurance attestations.

Link copied to clipboard
@SerialName(value = "issuing_country")
val issuingCountry: String

Alpha-2 country code, as defined in ISO 3166-1, of the Health ID attestation Provider's country or territory.

Link copied to clipboard
@SerialName(value = "issuing_jurisdiction")
val issuingJurisdiction: String? = null

Country subdivision code of the jurisdiction that issued the attestation, as defined in ISO 3166-2:2020, Clause 8. The first part of the code SHALL be the same as the value for issuingCountry.

Link copied to clipboard
@SerialName(value = "one_time_token")
val oneTimeToken: String? = null

Character string that enables the health care provider to identify the person via international search mask (national format)

Link copied to clipboard
@SerialName(value = "patient_id")
val patientId: String? = null

Character string that enables the health care provider to identify the person via international search mask (national format)

Link copied to clipboard
@SerialName(value = "tax_number")
val taxNumber: String? = null

Character string that enables the health care provider to identify the person via international search mask (national format)