PersonRegistry.AddPerson
Contents
Operation-level Profile
| Operation Name | PersonRegistry.AddPerson |
| Purpose Description | The aim of the PersonRegistry.AddPerson service is to request the receiving application to assign a unique identifier for a person. This service is used to request an FH-number. |
| Logic Description | The service creates unconditionally a new identity with the attributes from the request. |
| Input/Output | Input: Person Registry Add Person Request (PRPA_IN101311NO). The core component is an instance of the Generic Person Model with the exception of the IdentifiedPerson.id attribute, which is not present in the context of the request to this service. It is allowed to have all attributes empty, confer with use case Emergency Alert described below. Output: Person Registry Application Acknowledgement (PRPA_IN101319NO). If the request was processed successfully its core component is an instance of the Generic Person Model. The new person is identified by the IdentifiedPerson.id attribute. See below for details of the information model as well as examples. |
| Composition Role | Business level service |
| Composition Member Capabilities | None |
| Keywords | FH-number, Demographics data, person, create, add, temporary person identifier, Folkeregister |
| Version | 5.0 |
| Finalization Status within HL7 Norway | For review |
| Custodian | HL7 Norway |
Purpose of the operation
The storyboard demonstrates a local person registry sending a request to an enterprise (or national or regional) person registry to add a new record to the enterprise person registry. The enterprise person registry system will respond with a confirmation and the enterprise identifier for the new person record, or it will respond with a rejection and the reason for the rejection.
Storyboard Diagram
Textual Storyboard
- Newborn
| Nelda Nuclear delivers her baby son, Ned Nuclear, in Good Health Hospital. The hospital adds the newborn to the source system, assigning a medical record number for the baby, records the mother's unique identifier, mother's name, and newborn demographic data. An add client request is sent to the jurisdictional client registry system (Folkeregisteret). The Folkeregister sends an FH-number (Felles Hjelpenummer) in return to the hospital, to be used until the final social security number has been generated.
The Folkeregister adds the new person information to the registry and generates a unique client identifier which is returned in the add client confirmation message sent to the source system. |
- Fetus
| The doctor Tom Expert will have to perform surgery on a fetus immediately after birth. The surgery has to be planned, and the baby needs its own id. The doctors' secretary Anna adds the baby along with the mothers demographics into the system. The system sends an add client request, and receives an FH-number to be used until the baby is born and has received his own social security number. |
- Dead born baby
| Doctor Tom Begood wants to order laboratory tests and x-ray tests to investigate the cause of a dead born baby. He needs to identify the baby with a unique id. He asks for an FH-number from the Folkeregister. This baby will not receive a social security number later. |
- Tourists and other people without social security number
| Fred Tourist has broken his arm and visits the Emergency Room. Fred Tourist does not have a Norwegian social security number, as he is from the Netherlands. Secretary Anna registrates his demographic information in the patientregistry and ask for an FH-number from the Folkeregister service. This ID is used for Fred Tourist as he is sent to the hospital for surgery of the complicated fracture. |
- John Doe is unconscious
| The alam central receives a call from Hans Hansen. He has found an unconscious person in the street. He doesn't know the person, but he can describe the patient as a male in his 50's, and he is located in Storgata. The alarm central orders an ambulance, alert the hospital and registers the limited information about the man. The alarm central operator asks the Folkeregister for an ID to be used to identify this John Doe. The Folkeregister returns an FH-number to be used until the person can be identified. |
- Emergency Alert
| In case of larger catastrophes the Good Health Hospital orders several FH-numbers to be assigned to patient if necessary. This could be avalanches, car crashes, airplane accidents etc. The Good Health Hospital also needs a backup plan in case of down-time in the computer system. |
- Test patients
| Marius Computerman needs to test his new system. To be able to test it properly, he needs to test it on persons in the Folkeregister. The Folkeregister flags the test person, and returns a test person with an FH-number. |
Input/Output
The request has an immediate response in the form of a Person Registry Application Acknowledgement.
| Person Registry Request Add Person | PRPA_IN101311NO |
| Person Registry Application Acknowledgement | PRPA_IN101319NO |
| Note that the above interactions use the “NO” realm code. The models used are (currently) specific for this project and will be brought forward for inclusion in the international standard. |
Input Information Model
The model is defined in the form of two wrappers (which contain meta-data related to the information exchange); the Transmission Wrapper, the ControlAct Wrapper, the Registration Act (a RegistrationRequest) and a so-called payload model. The model is equal to the model documented as Generic Person Model, with the exception of the IdentifiedPerson.id attribute, which is not present in this context.
Output Information Model
See Person Registry Application Acknowledgement for documentation.
Error Handling
See Error Handling for a general discussion of how errors can be identified in the response.
The response may contain an indication of errors during the processing of the request. The error codes are taken from the PersonRegistryErrors coding system (managed/maintained by NHN), with OID 2.16.578.1.12.4.5.2.1.1.
In case of processing errors the value of Acknowledgement.typeCode will be set to "AE", and the value of the DetectedIssueEvent.code attribute will be set to one of the codes shown below.
| Lvl | Code | Description | Documentation |
| 1 | SERVERROR | Generic error | Uncaught exception, either from code or database - will only occur if there is a bug in the link/unlink code. |
| 2 | NOFHAVAIL | No FH numbers available | The server has ran out of available FH numbers to assign to newly added persons |
XML Examples
Input Example
<PRPA_IN101311NO01 ITSVersion="XML_1.0" xmlns="urn:hl7-org:v3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <id extension="1105251404008484" root="2.16.578.1.34.1.408.7"/> <creationTime value="20110525140400"/> <versionCode code="NE2010NO"/> <interactionId extension="PRPA_IN101311NO01" root="2.16.840.1.113883.1.6"/> <processingCode code="P"/> <processingModeCode code="T"/> <acceptAckCode code="AL"/> <receiver typeCode="RCV"> <device classCode="DEV" determinerCode="INSTANCE"> <!-- Receiving software application. NHN Person Registry --> <id root="2.16.578.1.12.4.5.1.1"/> </device> </receiver> <sender typeCode="SND"> <device classCode="DEV" determinerCode="INSTANCE"> <id extension="408" root="2.16.578.1.34.1"/> </device> </sender> <controlActProcess classCode="CACT" moodCode="EVN"> <authorOrPerformer typeCode="AUT"> <assignedPerson classCode="ASSIGNED"> <id extension="12345" root="2.16.578.1.34.3.1"/> </assignedPerson> </authorOrPerformer> <subject typeCode="SUBJ"> <registrationRequest classCode="REG" moodCode="RQO"> <id nullFlavor="UNK"/> <statusCode code="active"/> <subject1 typeCode="SBJ"> <identifiedPerson classCode="IDENT"> <statusCode code="active"/> <identifiedPerson> <name use="L"> <given>Baby Boy</given> <family>Vinje</family> </name> <administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1"/> <birthTime value="201105240900"/> <personalRelationship> <code code="MTH" codeSystem="2.16.840.1.113883.5.111"/> <relationshipHolder> <id root="2.16.578.1.12.4.1.4.1" extension="33123456789" assigningAuthorityName="F-Number"/> <name> <given>Bente</given> <family>Vinje</family> </name> </relationshipHolder> </personalRelationship> </identifiedPerson> </identifiedPerson> </subject1> <author typeCode="AUT"> <assignedEntity classCode="ASSIGNED"> <id extension="12345" root="2.16.578.1.34.3.1"/> </assignedEntity> </author> </registrationRequest> </subject> </controlActProcess> </PRPA_IN101311NO01>
