Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 2.29 KB

pit.md

File metadata and controls

51 lines (40 loc) · 2.29 KB
Raw

Domain 'patientidentifiertypes'

The patientidentifiertypes subfolder contains CSV import files for saving patient identifier types in bulk. This is a possible example of its content:

patientidentifiertypes/
  ├── patientidentifiertypes.csv
  └── ...

There is currently only one format for the patient identifier type CSV line, here are the possible headers:

| Uuid | Void/Retire | Name | Description | Required | Format | Format description | Validator | Location behavior | Uniqueness behavior | _order:1000 | | - | - | - | - | - | - | - | - | - | - |

Headers that start with an underscore such as _order:1000 are metadata headers. The values in the columns under those headers are never read by the CSV parser.

Let's review some important headers.

Header Name

Mandatory. This is not a localized header.

Header Required

A true/false whether every patient MUST have this patient identifier type. Note that a blank or missing value will trigger an exception:

org.hibernate.PropertyValueException:
  not-null property references a null or transient value : org.openmrs.PatientIdentifierType.required

This requires to actively set the value to a true-able (TRUE, 1, Yes, ...) or a false-able value (False, 0, No, ...).

Header Format

A regular expression defining what the identifier text should contain. Note that backslashes must be backslash-escaped.

Header Format description

Textual explanation of the "Format" regular expression.

Header Validator

The full class name of an IdentifierValidator.

Header Location behavior

Specifies the way that location may be applicable for a particular Patient Identifer Type. Valid options are NOT_USED and REQUIRED.

Header Uniqueness behavior

Valid options are

  • LOCATION: Identifiers should be unique only across a location if the identifier's location property is not null
  • NON_UNIQUE: Duplicate identifiers are allowed
  • UNIQUE: Identifiers should be globally unique

Further examples:

Please look at the test configuration folder for sample import files for all domains, see here.