 HL7 PA, R2-2010 HL7 Version 3 Standard: Patient Administration, DSTU Release 2 Update February 2010 Update to DSTU Release 2 |
Content Last Edited: 2011-06-17T13:44:56
5.2 Storyboards
5.3 Application Roles
5.4 Trigger Events
5.5 Refined Message Information Models
5.6 Hierarchical Message Descriptions
5.7 Interactions
The Service Delivery Location topic defines messages exchanged with Service Delivery Location Registries. Service Delivery Location is a role played by a place at which services may be provided. A service delivery location may be either an incidental service delivery location (a place at which services may be provided without prior designation or authorization) or a dedicated service delivery location (a place that is intended to house the provision of services). Dedicated service delivery locations can be further characterized as either clinical (DedicatedClinicalLocationRoleType) or non-clinical (DedicatedNonClinicalLocationRoleType). A single physical place can play multiple service delivery location roles each with its own attributes. For example, a Podiatry clinic and Research clinic may meet on alternate days in the same physical location; each clinic uses its own mailing address and telephone number.
This document includes message specifications for:
- Notifications for state transitions of activated, revised, nullified and obsolete (duplicates resolved)
- Queries for Find Candidates, Get Details and Get Identifiers
- Requests for adding and revising records
Possible future work includes:
- Notification messages for other state transitions such as suspended or terminated
- Representing service delivery location registry information in structured document and service profile specifications
The Patient Administration Technical Committee invites implementers with additional requirements to submit content proposals for future releases of the standard.
This DSUT update includes only technical corrections to the R2-2007 DSTU content. The Control Act wrappers for two interactions were changed. The Master File / Reg Notif. Control Act, Role Subject wrapper was replaced with the Master File / Reg Request Control Act, Role Subject wrapper. These interactions represent a registry rejecting a request so to conform to the Registration Request, Fulfillment, Notifications storyboard in the Master File - Registries topic, the reject response "contains the identification of the registration request being rejected."
- PRPA_IN202313UV (Location Registry Add Request Rejected)
- PRPA_IN202316UV (Location Registry Revise Request Rejected)
None.
|
||||||||||||||||||||||
|
For details on the interpretation of this section, see the storyboard discussion in the Version 3 Guide.
This storyboard demonstrates notifying tracking systems after a record is added to a service delivery location registry.
| Location Registry Record Added |  PRPA_IN202301UV02 |
Good Health Hospital is opening a new bone marrow transplant program. In preparation for putting the program in service the data entry clerk adds the new service delivery locations to the hospital's location registry for the Bone Marrow Transplant Unit patient rooms, operating theater, recovery room and Bone Marrow Transplant outpatient clinic. The registry then sends Location Registry Record Added notifications to location registry tracking systems.
This storyboard demonstrates notifying tracking systems after a record is revised in a service delivery location registry.
| Location Registry Record Revised | PRPA_IN202302UV02 |
A wing of the Good Health Hospital has undergone renovation and some patient locations need to be updated in the service delivery location registry (e.g. some rooms now can be used for patients needing particular services, such as isolation). The data entry clerk updates the records in the hospital's location registry and the registry sends Location Registry Record Revised notifications to location registry tracking systems.
This storyboard demonstrates notifying tracking systems after an erroneous record in a service delivery location registry has been nullified. Note, addressing a duplicate record is described in Location Registry Duplicates Resolved storyboard.
| Location Registry Record Nullified | PRPA_IN202303UV02 |
The Good Health Hospital is preparing to open a new wing of the hospital in a few weeks and the new hospital locations need to be added to the system. The system administrator adds the new service delivery location records to the hospital's location registry and the system notifies location registry tracking systems. Later that day the system administrator learns that one of the locations was incorrect so the record is nullified in the location registry and a Location Registry Record Nullified notification is sent to location registry tracking systems.
This storyboard demonstrates resolving duplicate records in a location registry. The incorrect registration is marked "obsolete" and linked to the surviving registration.
| Location Registry Duplicates Resolved | PRPA_IN202304UV02 |
This storyboard demonstrates querying a location registry for a list of records matching a set of location details.
| Location Registry Find Candidates Query | PRPA_IN202305UV02 |
| Location Registry Find Candidates Query Response | PRPA_IN202306UV02 |
This storyboard demonstrates querying a location registry to get detailed information for a registered location.
| Location Registry Get Details Query | PRPA_IN202307UV02 |
| Location Registry Get Details Query Response | PRPA_IN202308UV02 |
On Saturday evening the physician on duty at Good Health Hospital asked the ward clerk to contact the Home Health Care Clinic so she could discuss arranging for home health nurse visits after Mr. Everyman is discharged. The ward clerk entered the identifier for Home Health Care Clinic and initiated a Location Registry Get Details Query to the enterprise service delivery location registry. The registry immediately returned a Location Registry Get Details Query Response which included the name and telephone number for the weekend evening contact person for Home Health Care Clinic.
This storyboard demonstrates querying a location registry to get all identifiers for a registered location.
| Location Registry Get Identifiers Query | PRPA_IN202309UV02 |
| Location Registry Get Identifiers Query Response | PRPA_IN202310UV02 |
| Location Registry Add Request | PRPA_IN202311UV02 |
| Location Registry Add Request Accepted | PRPA_IN202312UV02 |
| Location Registry Add Request Rejected | PRPA_IN202313UV02 |
Good Health Hospital is opening a new bone marrow transplant program. In preparation for putting the program in service the data entry clerk added the new service delivery locations to the hospital's location registry for the Bone Marrow Transplant Unit patient rooms, operating theater, recovery room and Bone Marrow Transplant outpatient clinic. After Good Health Hospital officially opened the new program it sent a Location Registry Add Request interaction from its local service delivery location registry to the regional service delivery location registry requesting that its Bone Marrow Transplant outpatient clinic be added to the regional registry.
The regional service delivery location registry accepted the request, added the GHH Bone Marrow Transplant outpatient clinic to the regional registry and returned a Location Registry Add Request Accepted interaction with the identifier assigned to the clinic for by regional registry.
Good Health Hospital is opening a new bone marrow transplant program. In preparation for putting the program in service the data entry clerk added the new service delivery locations to the hospital's location registry for the Bone Marrow Transplant Unit patient rooms, operating theater, recovery room and Bone Marrow Transplant outpatient clinic. After Good Health Hospital officially opened the new program it sent a Location Registry Add Request interaction from its local service delivery location registry to the regional service delivery location registry requesting that its Bone Marrow Transplant outpatient clinic be added to the regional registry.
The regional service delivery location registry received the request but rejected it because it could not validate the code used to classify the location it as a bone marrow transplant clinic. The regional registry returned a Location Registry Add Request Rejected interaction with a Detected Issue of "invalid code."
| Location Registry Revise Request | PRPA_IN202314UV02 |
| Location Registry Revise Request Accepted | PRPA_IN202315UV02 |
| Location Registry Revise Request Rejected | PRPA_IN202316UV02 |
Good Health Hospital recently converted its Pediatric Care Unit to a Pediatric Neonatal Intensive Care Unit. The location registry system manager updated the record in the hospital's location registry and initiated a Location Registry Revise Request to the regional service delivery location registry.
The regional service delivery location registry accepted the request, revised the classification of the location and returned a Location Registry Revise Request Accepted interaction with a copy of the revised record from the regional registry.
Good Health Hospital recently converted its Pediatric Care Unit to a Pediatric Neonatal Intensive Care Unit. The data clerk updated the record in the hospital's location registry and initiated a Location Registry Revise Request to the regional service delivery location registry.
The regional service delivery location registry received the request but rejected it because it the data clerk was not listed as someone authorized to change location records for Good Health Hospital in the regional registry. The regional registry returned a Location Registry Revise Request Rejected interaction with a Detected Issue of "unauthorized author."
|
||||||||||||||||
|
For details on the interpretation of this section, see the discussion of application roles and their relationships in the Version 3 Guide.
This application role represents applications that initiate state transition requests to service delivery location registries.
This application role represents the responsibility of service delivery location registries to respond to state transition requests.
This application role represents the responsibility of service delivery location registries to notify systems of state transitions (such as add, revise, nullify) on records it holds. It replaces the Service Delivery Location Comprehensive Informer application role (MFPA_AR202001UV01) from DSTU 1.
This application role represents the responsibility to receive state transition notification messages from service delivery location registries. It replaces the Service Delivery Location Comprehensive Tracker application role (MFPA_AR202002UV01) from DSTU 1.
This application role represents applications that initiate queries to service delivery location registries.
This application role represents the responsibility of service delivery location registries to respond to queries.
|
||||||||||||||||||||||||||||||||||||
|
For details on the interpretation of this section, see the discussion of trigger events in the Version 3 Guide.
| Type: | State-transition based |
| State Transition: | RegistrationEvent (MFMI_RM700700UV01) |
This trigger event signals that a record was added to a service delivery location registry.
The Add Service Delivery Location trigger event most closely aligns with an HL7 2.4 MFN^M05 Patient location master file message with a Record-level event code in MFE-2 of MAD - add record to master file.
| Type: | User request |
A source system sends a location record to a service delivery location registry with a request to add the record to the registry.
| Type: | Interaction based |
This trigger event signals that a service delivery location registry has accepted a request to add a new record.
| Type: | Interaction based |
This trigger event signals that a service delivery location registry has rejected a request to add a new record.
| Type: | State-transition based |
| State Transition: | RegistrationEvent (MFMI_RM700700UV01) |
This trigger event signals that a record was revised in a service delivery location registry.
The Revise Service Delivery Location Information trigger event most closely aligns with an HL7 2.4 MFN^M05 Patient location master file message with a Record-level event code in MFE-2 of MUP - update record for master file.
| Type: | User request |
A source system sends a request to a service delivery location registry to make specific changes to the information it holds for a specified location.
| Type: | Interaction based |
This trigger event signals that a service delivery location registry has accepted a request to revise information it holds for a specified location.
| Type: | Interaction based |
This trigger event signals that a service delivery location registry has rejected a request to revise information it holds about a location.
| Type: | State-transition based |
| State Transition: | RegistrationEvent (MFMI_RM700700UV01) |
This trigger event signals that a record was nullified in a service delivery location registry.
The Nullify Service Delivery Location trigger event most closely aligns with an HL7 2.4 MFN^M05 Patient location master file message with a Record-level event code in MFE-2 of MDL - delete record from master file.
| Type: | State-transition based |
| State Transition: | PriorRegistration (MFMI_RM700700UV01) |
This trigger event signals that duplicate records were resolved in a service delivery location registry.
| Type: | User request |
A user initiates a query to a service delivery location registry requesting records that match a set of detailed information.
| Type: | Interaction based |
| Type: | User request |
A user initiates a query to a service delivery location registry requesting the detailed information the registry has recorded for a specified location.
| Type: | Interaction based |
A service delivery location registry responds to a Get Location Details Query request by returning the detailed information it has recorded for the location specified in the query.
| Type: | User request |
A user initiates a query to a service delivery location registry requesting the identifiers the registry has recorded for a specified location.
| Type: | Interaction based |
A service delivery location registry responds to a Get Associated Identifiers Query request by returning the identifiers it has recorded for the location specified in the query.
|
||||||||||||||||||||
|
For details on the interpretation of this section, see the description of RMIMs in the Version 3 Guide.
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Service Delivery Location Activate R-MIM defines the payload message used for state-transition requests and notifications for adding new records in a service delivery location registry.
Walk-through
ServiceDeliveryLocation
The ServiceDeliveryLocation class is the entry point to the R-MIM. It represents a role played by a Place at which services may be provided by an Organization. Note that providing services is not synonymous with "ownership." A given Place can play multiple service delivery location roles each with its own attributes. For example, a Podiatric clinic and Research clinic may meet on alternate days in the same physical location; each clinic uses its own mailing address and telephone number. A ServiceDeliveryLocation can exist within a hierarchy of other service delivery locations; for example, the Good Health Hospital contains the Emergency Ward which contains Emergency Bed Location A. These associations can be conveyed through the part and partOf role links.
Place
A bounded physical place or site with its contained structures, if any. A place may be natural or man-made. Its geographic position may or may not be constant. A mobile Place such as an ambulance would be conveyed by setting mobileInd to true. A Place can exist within a hierarchy of other places. The focal Place can be associated with a Place that contains it through the LocatedEntityPartOf role; for example, a wing is part of a building. The focal Place can be associated with a Place contained within it through the LocatedEntityHasParts role; for example, a wing contains rooms.
E_Organization
This is the (optional) organization that provides services at the ServiceDeliveryLocation.
A_SpatialCoordinate
The geographic coordinates of a ServiceDeliveryLocation can be conveyed in an A_SpatialCoordinate observation. Note that since a Place can be mobile it is possible that the ServiceDeliveryLocation might subjectOf of a sequence of spatial coordinate observations.
ServiceDefinition
The locationOf participation can associate a ServiceDeliveryLocation with the types of services (ServiceDefinition) that are available at that location.
ContactParty
A ServiceDeliveryLocation may have multiple means by which it may be contacted for various reasons. For example, there may be different contact persons and telephone numbers for scheduling appointments, renewing prescriptions, emergency contacts outside of normal working hours. These contact parties are associated with the ServiceDeliveryLocation through a directAuthorityOver role link. The type of contact is characterized by the ContactParty.code attribute.
IdentifiedLocation
External organizations such as payers and regulators may assign their own identifiers to service delivery locations. This type of identifier is conveyed in an IdentifiedLocation role associated with the ServiceDeliveryLocation through an indirectAuthorityOver role link. The organization using the identifier is identified by name in the IdentifierOrganization entity.
TerritorialAuthority
A ServiceDeliveryLocation may be located within a geographic region that falls under the jurisdiction of a territorial authority. For example, the Calgary Regional Health Authority has authority over the territory "Region 4 of Alberta" in matters of health. The ServiceDeliveryLocation is associated with a TerritorialAuthority through an indirectAuthority role link.
| Service Delivery Location Activate | PRPA_HD202301UV02 |
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Service Delivery Location Revise R-MIM defines the payload message used for state-transition requests and notifications for revising records in a service delivery location registry.
Walk-through
The Service Delivery Location Revise R-MIM differs from the Service Delivery Location Activate R-MIM in the following ways:
- ServiceDeliveryLocation - the statusCode attribute can take on any of the RoleStatusNormal values (excludes nullify) instead of the fixed value of "active"
- Update Mode - the revise message implements update mode to convey changes and the R-MIM specifies allowed update modes for certain attributes and associations. All other attributes and associations can take on any normally allowed update mode.
| Service Delivery Location Revise | PRPA_HD202302UV02 |
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Service Delivery Location Event Nullify R-MIM defines the payload for a state-transition notification after a record in a service delivery location registry has been nullified.
Walk-through
ServiceDeliveryLocation
- Mandatory id
- Mandatory code
- Required name
- Mandatory statusCode with fixed value of nullified
- Non-mandatory serviceProviderOrganization association
- Non-mandatory location association
| Service Delivery Location Nullify | PRPA_HD202305UV02 |
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Service Delivery Location Details R-MIM defines the payload message used for query responses that return a complete or partial record from a service delivery location registry.
Walk-through
The Service Delivery Location Details R-MIM differs from the Service Delivery Location Activate R-MIM by allowing the ServiceDeliveryLocationstatusCode attribute to take on any RoleStatus value instead of being fixed as "active."
| Service Delivery Location Details | PRPA_HD202303UV02 |
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Location Registry Find Candidates Response R-MIM defines the payload message used to return records from a service delivery location registry in response to a find candidates query. Each record includes an observation reporting how well the record matched the query parameters.
Walk-through
The Location Registry Find Candidates Response R-MIM is the same as the Service Delivery Location Details R-MIM with the addition of the QueryMatchObservation class.
| Location Registry Find Candidates Response | PRPA_HD202310UV02 |
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Service Delivery Location Identifiers R-MIM defines the payload message used return all identifiers associated with a record in a service delivery location registry.
Walk-through
The Service Delivery Location Identifiers R-MIM is a reduced version of the Service Delivery Location Details R-MIM with the following changes:
ServiceDeliveryLocation
- Remove all attributes except id, code, name and statusCode
- Remove all participations (spatialCoordinate and serviceDefinition)
- Remove reflexive role links (part and partOf)
- Remove all role links except for identifiedLocation
Place
- Remove all attributes except id, code and name
- Remove LocatedEntityPartOf and LocatedEntityHasParts associations
| Service Delivery Location Identifiers | PRPA_HD202304UV02 |
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Location Registry Query By Details R-MIM defines the payload for a query-by-parameter message sent to a Service Delivery Location Registry when the query placer knows a set of location attributes.
The response to a Query By Details may potentially return many records so the SortControl class and the responseModalityCode, initialQuantity and initialQuantityCode attributes of the QueryByParameter class are included in the information model.
Walk-through
QueryByParameter - This is the entry point to the R-MIM. This class allows the query requester to specify how the query should be processed by the query fulfiller.
- queryId - an identifier for the query. It is used to associate this query instance with both the initial response message and with later query interactions. Valuing queryId avoids the need for the QueryContinuation and QueryAck classes to carry as much detail information as is carried in the initial query.
- statusCode - a code specifying the state of this query (based on the RIM Act class state machine), for example, active, aborted, completed.
- modifyCode - indicates whether the subscription to a query is new or is being modified
- responseElementGroupId - an identifier for the specific message type to be returned in the query response. The message type is constrained to the set of message types supported by the receiver responsibilities associated with the query interaction.
- responseModalityCode - a code specifying the timing and grouping of the response instances
- responsePriorityCode - a code specifying the time frame in which a response is expected
- initialQuantity - the maximum size of the response that can be accepted by the requesting application.
- initialQuantityCode - a code specifying the units associated with the initialQuantity
- executionAndDeliveryTime - the time the response is to be returned
SortControl - This class allows the query requester to specify the order in which the server should return multiple results.
- sequenceNumber - the order of this elementName in the sort
- elementName - the name of the element upon which the response should be sorted
- directionCode - a code specifying the sort order (ascending, descending or none)
MatchCriterionList - This collection of parameter items convey instructions to the query fulfiller. The associated parameter items are joined with OR logic.
- MatchAlgorithm - This parameter conveys instructions to the query fulfiller specifying the preferred matching algorithm to use
- MinimumDegreeMatch - This parameter conveys instructions to the query fulfiller specifying the minimum degree of match to use in filtering results
- MatchWeight - This parameter conveys instructions to the query fulfiller specifying the desired weight to be assigned to parameter types in the matching process
ParameterList - This collection of parameter items for the query, similar to the WHERE clause in a SQL query. A query message can include any combination of the parameters. Multiple instances of parameter item are combined with AND logic. Multiple values in the value attribute of a single parameter item instance are combined with OR logic.
- SdlocName - a name for a service delivery location. The HL7 EN (entity name) data type is quite rich and the data type specification should be well understood before being used in a query. For example, the name use parameter can covey that a name is spelled phonetically or based on the SOUNDEX algorithm.
- SdlocType - a code specifying a type of service delivery location drawn from the ServiceDeliveryLocationRoleType domain; for example FMC (Family medicine clinic), CCU (Coronary care unit), INV (Infertility clinic).
- SdlocAddress - a postal or physical address for a service delivery location. This can be a full address or only an address component such as city or zip code.
- SdlocStatusCode - a code specifying the state of a record in a location registry. The parameter is used to find records in a particular state such as "active" or "completed".
- IdentifyingOrg - the name of an organization that has assigned its own identifier to a location. A location registry can hold identifiers used for a service delivery location by an organization other the organization that provides the services at the location.
- IdentifyingOrgId - an identifier used for a location by the IdentifyingOrg
- SdlocTerritorialAuthority - an identifier for a geographic region over which an organization has jurisdiction; for example, Region 4 of Alberta over which the Calgary Regional Health Authority has jurisdiction for heath matters.
- SdlocService - a code specifying a type of service that may be performed at a service delivery location.
| Location Registry Query By Details | PRPA_HD202306UV02 |
| Parent: | Patient Administration (PRPA_DM000000UV) |
Overview
The Location Registry Query By Identifier R-MIM defines the payload for a query-by-parameter message sent to a service delivery location registry when the query placer knows an identifier for a location record in the registry.
The response to a Query By Identifier will typically return a single record so the SortControl class and the responseModalityCode, initialQuantity and initialQuantityCode attributes of the QueryByParameter class are not included in the information model.
Walk-through
QueryByParameter - The entry point to the R-MIM. This class allows the query requester to specify how the query should be processed by the query fulfiller.
- queryId - an identifier for the query. It is used to associate this query instance with both the initial response message and with later query interactions. Valuing queryId avoids the need for the QueryContinuation and QueryAck classes to carry as much detail information as is carried in the initial query.
- statusCode - a code specifying the state of this query (based on the RIM Act class state machine), for example, active, aborted, completed.
- modifyCode - a code specifying whether the subscription to a query is new or is being modified
- responseElementGroupId - an identifier for the specific message type to be returned in the query response. The message type is constrained to the set of message types supported by the receiver responsibilities associated with the query interaction.
- responsePriorityCode - a code specifying the time frame in which a response is expected
- executionAndDeliveryTime - the time the response is to be returned
ParameterList - This collection of parameter items for the query, similar to the WHERE clause in a SQL query. A query message must include at least one ServiceDeliveryLocationIdentifier parameter item and may include DataSource parameter items. Multiple instances of parameter item are combined with AND logic. Multiple values in the value attribute of a single parameter item instance are combined with OR logic.
- ServiceDeliveryLocationIdentifier - an identifier for a location record in a service delivery location registry
- DataSource - the identifier for a data source (system). This supports data locator/aggregator type registries that respond to queries by farming the request out to other registries that hold the requested information.
| Location Registry Query By Identifier | PRPA_HD202307UV02 |
|
||||||||||||||||||||
|
For details on the interpretation of this section, see the description of HMDs in the Version 3 Guide.
The Service Delivery Location Activated payload message is used in state-transition notifications and state-transition requests for adding new records to a service delivery location registry.
| E_OrganizationUniversal | COCT_MT150000UV02 |
| A_SpatialCoordinateUniversal | COCT_MT960000UV05 |
| Service Delivery Location Activate | PRPA_MT202301UV02 | |
The Service Delivery Location Revised payload message is used in state-transition notifications and state-transition requests for revising existing records in a service delivery location registry.
| E_OrganizationUniversal | COCT_MT150000UV02 |
| A_SpatialCoordinateUniversal | COCT_MT960000UV05 |
| Service Delivery Location Revise | PRPA_MT202302UV02 | |
The Service Delivery Location Nullified payload message is used in the state-transition notification reporting nullification of an erroneously-entered record in a service delivery location registry.
| E_OrganizationContact | COCT_MT150003UV03 |
| Service Delivery Location Nullify | PRPA_MT202305UV02 | |
The Service Delivery Location Details payload message is used to return a complete or partial record from a service delivery location registry in response to a query.
| E_OrganizationUniversal | COCT_MT150000UV02 |
| A_SpatialCoordinateUniversal | COCT_MT960000UV05 |
| Service Delivery Location Details | PRPA_MT202303UV02 | |
The Find Candidates Response payload message is used to return records from a service delivery location registry in response to a find candidates query. Each record includes an observation reporting how well the record matched the query parameters.
| E_OrganizationUniversal | COCT_MT150000UV02 |
| A_SpatialCoordinateUniversal | COCT_MT960000UV05 |
| Location Registry Find Candidates Response | PRPA_MT202310UV02 | |
The Service Delivery Location Identifiers payload message is used to return all identifiers associated with a record in a service delivery location registry in response to a query.
| E_OrganizationIdentified | COCT_MT150001UV01 |
| Service Delivery Location Identifiers | PRPA_MT202304UV02 | |
The Query By Details payload message is used in query-by-parameter messages sent to a service delivery location registry when the query placer knows a set of location details.
| Location Registry Query By Details | PRPA_MT202306UV02 | |
The Query By Identifier payload message is used in query-by-parameter messages sent to a service delivery location registry when the query placer knows a location's registry identifier.
| Location Registry Query By Identifier | PRPA_MT202307UV02 | |
|
||||||||||||||||||||||||||||||||||||
|
For details on the interpretation of this section, see the definition of Interactions in the Version 3 Guide.
A service delivery location registry sends this notification after adding a record to the registry. This interaction replaces the New Service Delivery Location Added interaction (MFPA_IN202001UV01) from DSTU 1.
| Trigger Event | Location Registry Record Added | PRPA_TE202301UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Master File / Reg Notif. Control Act, Role Subject | MFMI_MT700701UV01 |
| Message Type | Service Delivery Location Activate | PRPA_MT202301UV02 |
| Sender | Location Registry Informer | PRPA_AR202301UV02 |
| Receiver | Location Registry Tracker | PRPA_AR202302UV02 |
A user initiates a request to add a record to a service delivery location registry.
| Trigger Event | Location Registry Add Request | PRPA_TE202311UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Master File / Reg Request Control Act,Role Subject | MFMI_MT700721UV01 |
| Message Type | Service Delivery Location Activate | PRPA_MT202301UV02 |
| Reason | Trigger Event | Interaction |
| A Request Fulfiller application role is responsible for informing a requesting application role if its activation request is accepted | PRPA_TE202312UV02 | PRPA_IN202312UV02 |
| A Request Fulfiller application role is responsible for informing a requesting application role if its activation request is rejected and why | PRPA_TE202313UV02 | PRPA_IN202313UV02 |
| Sender | Location Registry Request Placer | PRPA_AR202305UV02 |
| Receiver | Location Registry Request Fulfiller | PRPA_AR202306UV02 |
A service delivery location registry accepts a request to add a record and responds back to the requesting application. The payload contains the identifier assigned to the new location record.
| Trigger Event | Location Registry Add Request Accepted | PRPA_TE202312UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Master File / Reg Notif. Control Act, Role Subject | MFMI_MT700701UV01 |
| Message Type | Service Delivery Location Identifiers | PRPA_MT202304UV02 |
| Sender | Location Registry Request Fulfiller | PRPA_AR202306UV02 |
| Receiver | Location Registry Request Placer | PRPA_AR202305UV02 |
A service delivery location registry rejects a request to add a record and responds back to the requesting application. The reason for the rejection is returned as a Detected Issue in the Master File / Reg Request Control Act,Role Subject wrapper. The payload returns the location record sent in the original request
| Trigger Event | Location Registry Add Request Rejected | PRPA_TE202313UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Master File / Reg Request Control Act,Role Subject | MFMI_MT700721UV01 |
| Message Type | Service Delivery Location Activate | PRPA_MT202301UV02 |
| Sender | Location Registry Request Fulfiller | PRPA_AR202306UV02 |
| Receiver | Location Registry Request Placer | PRPA_AR202305UV02 |
A service delivery location registry sends this notification after revising a record in the registry. This interaction replaces the Service Delivery Location Information Revised interaction (MFPA_IN202002UV01) from DSTU 1.
| Trigger Event | Location Registry Record Revised | PRPA_TE202302UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Master File / Reg Notif. Control Act, Role Subject | MFMI_MT700701UV01 |
| Message Type | Service Delivery Location Revise | PRPA_MT202302UV02 |
| Sender | Location Registry Informer | PRPA_AR202301UV02 |
| Receiver | Location Registry Tracker | PRPA_AR202302UV02 |
A user initiates a request to revise an existing record to a service delivery location registry.
| Trigger Event | Location Registry Revise Request | PRPA_TE202314UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Master File / Reg Request Control Act,Role Subject | MFMI_MT700721UV01 |
| Message Type | Service Delivery Location Revise | PRPA_MT202302UV02 |
| Reason | Trigger Event | Interaction |
| A Request Fulfiller application role is responsible for informing a requesting application role if its revision request is accepted | PRPA_TE202315UV02 | PRPA_IN202315UV02 |
| A Request Fulfiller application role is responsible for informing a requesting application role if its revision request is rejected and why | PRPA_TE202316UV02 | PRPA_IN202316UV02 |
| Sender | Location Registry Request Placer | PRPA_AR202305UV02 |
| Receiver | Location Registry Request Fulfiller | PRPA_AR202306UV02 |
A service delivery location registry accepts a request to revise an existing record and responds back to the requesting application. The revised location record from the registry is returned in the payload.
| Trigger Event | Location Registry Revise Request Accepted | PRPA_TE202315UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Master File / Reg Notif. Control Act, Role Subject | MFMI_MT700701UV01 |
| Message Type | Service Delivery Location Details | PRPA_MT202303UV02 |
| Sender | Location Registry Request Fulfiller | PRPA_AR202306UV02 |
| Receiver | Location Registry Request Placer | PRPA_AR202305UV02 |
A service delivery location registry rejects a request to revise an existing record and responds back to the requesting application. The reason for the rejection is returned as a Detected Issue in the Master File / Reg Request Control Act,Role Subject wrapper. The payload returns the location record sent in the original request.
| Trigger Event | Location Registry Revise Request Rejected | PRPA_TE202316UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Master File / Reg Request Control Act,Role Subject | MFMI_MT700721UV01 |
| Message Type | Service Delivery Location Revise | PRPA_MT202302UV02 |
| Sender | Location Registry Request Fulfiller | PRPA_AR202306UV02 |
| Receiver | Location Registry Request Placer | PRPA_AR202305UV02 |
A service delivery location registry sends this notification after nullifying an erroneously created record in the registry. This interaction replaces the Service Delivery Location Nullified interaction (MFPA_IN202003UV01) from DSTU 1.
| Trigger Event | Location Registry Record Nullified | PRPA_TE202303UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Master File / Reg Notif. Control Act, Role Subject | MFMI_MT700701UV01 |
| Message Type | Service Delivery Location Nullify | PRPA_MT202305UV02 |
| Sender | Location Registry Informer | PRPA_AR202301UV02 |
| Receiver | Location Registry Tracker | PRPA_AR202302UV02 |
A service delivery location registry sends this notification after resolving duplicate registrations in the registry. The surviving registration (RegistrationEvent.statusCode = "active") links via the replacementOf act relationship to the deprecated registration (PriorRegistration.statusCode = "obsolete"). A copy of the surviving location record is sent in the payload message.
| Trigger Event | Location Registry Duplicates Resolved | PRPA_TE202304UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Master File / Reg Notif. Control Act, Role Subject | MFMI_MT700701UV01 |
| Message Type | Service Delivery Location Details | PRPA_MT202303UV02 |
| Sender | Location Registry Informer | PRPA_AR202301UV02 |
| Receiver | Location Registry Tracker | PRPA_AR202302UV02 |
A user initiates a query to a service delivery location registry requesting all records that match a particular set of parameters.
| Trigger Event | Location Registry Find Candidates Query | PRPA_TE202305UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Query By Parameter | QUQI_MT021001UV |
| Query Definition | Location Registry Query By Details | PRPA_MT202306UV02 |
| Reason | Trigger Event | Interaction |
| A Query Fulfiller application role is responsible for responding to queries | PRPA_TE202306UV02 | PRPA_IN202306UV02 |
| Sender | Location Registry Query Placer | PRPA_AR202303UV02 |
| Receiver | Location Registry Query Fulfiller | PRPA_AR202304UV02 |
A service delivery location registry responds to a query with all records in the registry that match the parameters in the query. The response may also include a score indicating the probability of match for each candidate.
| Trigger Event | Location Registry Find Candidates Query Response | PRPA_TE202306UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Master File / Registry Query Response,Role Subject | MFMI_MT700711UV01 |
| Query Response Type | Service Delivery Location Details | PRPA_MT202303UV02 |
| Query Definition | Location Registry Query By Details | PRPA_MT202306UV02 |
| Sender | Location Registry Query Fulfiller | PRPA_AR202304UV02 |
| Receiver | Location Registry Query Placer | PRPA_AR202303UV02 |
A user initiates a query to a service delivery location registry requesting detailed information for a specific location.
| Trigger Event | Location Registry Get Details Query | PRPA_TE202307UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Query By Parameter | QUQI_MT021001UV |
| Query Definition | Location Registry Query By Identifier | PRPA_MT202307UV02 |
| Reason | Trigger Event | Interaction |
| A Query Fulfiller application role is responsible for responding to queries | PRPA_TE202308UV02 | PRPA_IN202308UV02 |
| Sender | Location Registry Query Placer | PRPA_AR202303UV02 |
| Receiver | Location Registry Query Fulfiller | PRPA_AR202304UV02 |
A service delivery location registry responds to a query with detailed information in the registry for the location specified in the query.
| Trigger Event | Location Registry Get Details Query Response | PRPA_TE202308UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Master File / Registry Query Response,Role Subject | MFMI_MT700711UV01 |
| Query Response Type | Service Delivery Location Details | PRPA_MT202303UV02 |
| Query Definition | Location Registry Query By Identifier | PRPA_MT202307UV02 |
| Sender | Location Registry Query Fulfiller | PRPA_AR202304UV02 |
| Receiver | Location Registry Request Placer | PRPA_AR202305UV02 |
A user initiates a query to a service delivery location registry requesting all identifiers for a specific location.
| Trigger Event | Location Registry Get Identifiers Query | PRPA_TE202309UV02 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Query By Parameter | QUQI_MT021001UV |
| Query Definition | Location Registry Query By Identifier | PRPA_MT202307UV02 |
| Reason | Trigger Event | Interaction |
| A Query Fulfiller application role is responsible for responding to queries | PRPA_TE202310UV02 | PRPA_IN202310UV02 |
| Sender | Location Registry Query Placer | PRPA_AR202303UV02 |
A service delivery location registry responds to a query with all identifiers in the registry for the location specified in the query.
| Trigger Event | Location Registry Get Identifier Query Response | PRPA_TE202310UV02 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Master File / Registry Query Response,Role Subject | MFMI_MT700711UV01 |
| Query Response Type | Service Delivery Location Identifiers | PRPA_MT202304UV02 |
| Query Definition | Location Registry Query By Identifier | PRPA_MT202307UV02 |
| Sender | Location Registry Query Fulfiller | PRPA_AR202304UV02 |
| Receiver | Location Registry Query Placer | PRPA_AR202303UV02 |
| Return to top of page |