chore: add patientIdentifierType resources #10
Conversation
batbrain7
changed the title
|
@bmamlin updated the PR, please review |
patientIdentifierType.md
Outdated
| "name": "Wilson Hospital Medical Record Number", | ||
| "description": "Wilson Hospital Medical Record Number is used as a patientIdentifier type.", |
There was a problem hiding this comment.
Names are used as labels, so better to keep short. Description is user-facing information to clarify a likely abbreviated name. Users would not be expected to know or care about an internal Java class like PatientIdentifierType. I would suggest something like:
"name": "Wilson Hosp MRN",
"description": "Wilson Hospital Medical Record Number",
patientIdentifierType.md
Outdated
| { | ||
| "name": "Wilson Hospital Medical Record Number", | ||
| "description": "Wilson Hospital Medical Record Number is used as a patientIdentifier type.", | ||
| "format": "234-7", |
There was a problem hiding this comment.
As your documentation explains, format is "a regular expression defining what the identifier text should contain." The regular expression "234-7" only matches a single string: the literal value "234-7". To make matters worse, not even the exact value would be accepted, since it has an invalid check digit.
I would suggest:
"format": "\d{1,10}-\d",
The regular expression \d{1,10}-\d matches 1-10 digit(s) (\d{1,10}) followed by a literal hyphen (-) and a single digit. If you want to limit the medical record system to 1000 patients by using the pattern NNN-N, the corresponding regular expression would be \d{3}-\d.
patientIdentifierType.md
Outdated
| #### Properties | ||
|
|
||
| Parameter | Type | Description | ||
| --- | --- | --- | ||
| *Object* | `PatientIdentifierType` | Patient resource with updated properties (same body as while creating the resource body) |
There was a problem hiding this comment.
The body of the POST isn't a property. I would eliminate this section.
patientIdentifierType.md
Outdated
|
|
||
| ```console | ||
| POST /patientidentifertype/:target_patientidentifiertype_uuid | ||
| -d modified_patientidentifiertype_object |
There was a problem hiding this comment.
I'm not sure what this means. I assume the -d is a reference to a cURL command, suggesting the updates would be in JSON format in a file named "modified_patientidentifiertype_object". Please omit the -d option and include an example JSON object after the POST command. See encounter.md for an example.
There was a problem hiding this comment.
sure, will update
There was a problem hiding this comment.
@bmamlin for this particular object I'll use this one :
` {
"name": "Wilson Hosp MRN",
"description": "Wilson Hospital Medical Record Number",
"format": "\d{1,10}-\d",
"formatDescription": "Up to ten digts followed by a hyphen and another digit",
"required": true,
"validator": "org.openmrs.patient.impl.LuhnIdentifierValidator",
"checkDigit": true,
"locationBehavior": "REQUIRED",
"uniquenessBehavior": "Unique"
}`
patientIdentifierType.md
Outdated
| &q=**searchqQuery** | ||
| ``` | ||
|
|
||
| * #### List patientIdentifierType by UUID. |
There was a problem hiding this comment.
This is "Get", not "List", since you are fetching a single resource.
There was a problem hiding this comment.
sure, will update
patientIdentifierType.md
Outdated
|
|
||
| ```console | ||
| GET /patientidentifiertype? | ||
| &q=**searchqQuery** |
There was a problem hiding this comment.
?q={searchQuery} doesn't make sense here, since you are describing getting all patient identifier types. If searching for patient identifier types was supported (I don't think it is), you would want to describe it separately.
There was a problem hiding this comment.
yes, to list the patientIdentiferTypes nothing is required, will update
Description
Added the patientIdentifierType resource.