Form Chart Value CodeSystem Code system

Canonical	../CodeSystem/nexus-form-chart-value
Status	draft · 1.26.0
Content	complete
Source	FSH · JSON

The values a form template's field mapping may draw from a patient's chart. Codes are dotted paths naming what is read (patient.address) and, where a form splits a value across boxes, the part of it (patient.address.city, patient.birthDate.year).

Each code resolves to text from the patient record; how that text lands depends on the field it is mapped to (see the Form Template Field Mapping extension): a text field takes it as text, a checkbox or radio button is checked when its export value equals it, and a choice field selects the option whose export or display value equals it. Where the chart holds no value, or nothing on the field matches, the field is left blank. Names come from the patient's official name; the address is the residential address, falling back to the mailing address; the phone is the first of home, mobile and work; the Social Insurance Number is the identifier typed SS, as stored; the health number is the identifier typed JHN, its version code read from that identifier's version-code extension; the most responsible provider is the practitioner the patient's generalPractitioner names.

Code	Display	Definition
patient.fullName	Full name	The patient's first given name and family name, from the official name, joined with a space.
patient.firstName	First name	The patient's first given name, from the official name.
patient.lastName	Last name	The patient's family name, from the official name.
patient.birthDate	Date of birth	The full date of birth as an ISO 8601 date, YYYY-MM-DD. A date of birth recorded to less than the full day yields nothing, and the field is left blank.
patient.birthDate.day	Day of birth	The day of the month of the date of birth, two digits, zero-padded (07).
patient.birthDate.month	Month of birth	The month of the date of birth, two digits, zero-padded (03).
patient.birthDate.year	Year of birth	The year of the date of birth, four digits.
patient.gender	Gender	The patient's administrative gender as its FHIR code: male, female, other or unknown. On a checkbox group the box whose export value equals the code is checked; on a text …
patient.phone	Phone number	The patient's phone number as recorded, taking the first present of the home, mobile and work numbers.
patient.address	Address	The patient's residential address (or mailing address when no residential one is recorded) as a single line: street, city, province, postal code.
patient.address.street	Street address	The street lines of the address, joined with a space.
patient.address.city	City	The address's city.
patient.address.province	Province	The address's province or state as its two-letter code (ON). On a choice field the option whose export or display value equals the code is selected.
patient.address.postalCode	Postal code	The address's postal code as recorded.
patient.socialInsuranceNumber	Social Insurance Number	The patient's Social Insurance Number as recorded on the identifier typed SS (the HL7 identifier type for a social insurance or security number): the digits as stored, with no g…
patient.healthNumber	Health number	The patient's provincial health card number as recorded on the identifier typed JHN (the HL7 identifier type for a jurisdictional health number), followed by a single space and …
patient.healthNumber.number	Health number, number only	The health card number alone, without its version code, as recorded.
patient.healthNumber.versionCode	Health number version code	The health card's version code alone, in upper-case letters. A card with no version code leaves the field blank.
patient.mrp	Most responsible provider	The display name of the patient's most responsible provider: the practitioner the record names under generalPractitioner. A record naming no provider leaves the field blank.