FHIR resource link

https://www.hl7.org/fhir/patient.html

https://build.fhir.org/patient-definitions.html

FHIR definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

PSI use case

unique client for which we have at least 1 identifier

FHIR required properties

see below

PSI required properties*

Country and PsiProjectCode *

At least one patient identifier

Extensions

Implemented: none

Under consideration:

• BirthSex - Jul 2022

• enforcement of identifiers - Aug 2022

• Gender values - Aug 2022

Sample payload

(minimum set)

PSI tags

0.8

REQUIRED [fhir]

Country ISO-3 code

Project Code

PENDING: implementation of this property

identifier

0.8

REQUIRED [fhir] - at least one unique value should be provided.

At least one UNIQUE identifier must be provided. Examples:

• Social ID (phone number, email, google, facebook, whatsapp, phone, zalo)

• If phone number is to be shared, a second keyword must be provided, separated by a “:”. Example “+17088727636:chaska”. Additionally, the telecom/use property shall be set to “temp” rather than “mobile”. Secrets are alpha-numeric A-Z,a-z,0-9 (no special characters)

• National ID or Social Security number

Uniqueness is across Country

name

OPTIONAL [psi]

If provided, please state:

• use (usual | official | temp | nickname | anonymous | old | maiden)

• period (start date)

telecom

OPTIONAL [psi]

If an email or a phone number is provided, you must include:

• system (phone | email | url | sms | other)

• use (home | work | temp | old | mobile)

  • mobile: indicates SOLE use of the device

  • temp: indicates SHARED use of the device

• period (start date)

• phone: always use +country code, no spaces

gender

OPTIONAL [psi]

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Normally asked and stored.

male | female | other | unknown

ext/sex assigned at birth

OPTIONAL [psi]

Use for medical diagnosis & treatment. Use for AI projects.

ext/sexual Orientation

OPTIONAL [psi]

Normally used in combination with Gender.

ext/gender Identity

OPTIONAL [psi]

Normally used in combination with Gender.

birthDate

OPTIONAL [psi]

If we do not know the exact date of birth, store as

• YYYY-MM

• YYYY

Age ranges: not supported

address

OPTIONAL [psi]

If provided, always include:

• use (usual | official | temp | nickname | anonymous | old | maiden)

• type: (postal | physical | both)

• country: ISO 3166 3 letters code

• period (start date)

communication/language

REQUIRED [psi]

FHIR recommendation: BCP-47 code - wikipedia

PENDING: how do we handle languages not in the BCP-47 subset?. Example: Shona (Zimbabwe)

should we consider ISO 639 ?

→ use this as the authoritative page: Language tags in HTML and XML