| PRPA_HD101306UV02 Person Registry Query By Demographics |
(Link to Excel View) Derived from RMIM: PRPA_RM101306UV02 |
||||||||
| QueryByParameter |
Design Comments: Entry point for the Query By Person Demographics payload message |
||||||||
| queryId [1..1] QueryByParameter (II) |
Design Comments: 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 [1..1] (M) QueryByParameter (CS) {CNE:V:QueryStatusCode} |
|||||||||
| modifyCode [0..1] QueryByParameter (CS) {CNE:V:ModifyIndicator} |
Design Comments: Indicates whether the subscription to a query is new or is being modified |
||||||||
| responseElementGroupId [0..*] QueryByParameter (DSET<II>) |
Design Comments: Identifies 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 [0..1] QueryByParameter (CS) {CNE:V:ResponseModality} |
Design Comments: Defines the timing and grouping of the response instances |
||||||||
| responsePriorityCode [0..1] QueryByParameter (CS) {CNE:V:QueryPriority} |
Design Comments: Identifies the time frame in which a response is expected |
||||||||
| initialQuantity [0..1] QueryByParameter (INT.POS) |
Design Comments: Defines the maximum size of the response that can be accepted by the requesting application |
||||||||
| initialQuantityCode [0..1] QueryByParameter (CD) {CWE:D:QueryRequestLimit} |
Design Comments: Defines the units associated with the initialQuantity |
||||||||
| executionAndDeliveryTime [0..1] QueryByParameter (TS) |
Design Comments: Specifies the time the response is to be returned |
||||||||
| matchCriterionList [0..1] (MatchCriterionList) |
Design Comments: This collection of parameter items convey instructions to the query fulfiller. The associated parameter items are joined with OR logic. |
||||||||
| parameterList [1..1] (ParameterList) | |||||||||
| sortControl [0..*] (SortControl) |
Design Comments: This class allows the query requester to specify the order in which the server should return multiple results. |
||||||||
| MatchCriterionList |
Design Comments: This collection of parameter items convey instructions to the query fulfiller. The associated parameter items are joined with OR logic. |
||||||||
| id [0..1] ParameterList (II) |
|||||||||
| matchAlgorithm [0..1] (MatchAlgorithm) |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the preferred matching algorithm to use |
||||||||
| matchWeight [0..1] (MatchWeight) |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the desired weight to be assigned to parameter types in the matching process. |
||||||||
| minimumDegreeMatch [0..1] (MinimumDegreeMatch) |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the minimum degree of match to use in filtering results. |
||||||||
| MatchAlgorithm |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the preferred matching algorithm to use |
||||||||
| value [1..1] ParameterItem (ANY) {CWE:D:QueryParameterValue} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "MatchAlgorithm"} |
|||||||||
| MatchWeight |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the desired weight to be assigned to parameter types in the matching process. |
||||||||
| value [1..1] ParameterItem (ANY) {CWE:D:QueryParameterValue} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "MatchWeight"} |
|||||||||
| MinimumDegreeMatch |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the minimum degree of match to use in filtering results. |
||||||||
| value [1..1] ParameterItem (ANY) {CWE:D:QueryParameterValue} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "MinimumDegreeMatch"} |
|||||||||
| ParameterList | |||||||||
| id [0..1] ParameterList (II) |
|||||||||
| groupId [0..*] (GroupId) |
Design Comments: This query parameter is the identifier for a group of which a person may be a member. It used to find persons who are members of a particular identified group. |
||||||||
| identifiedPersonAddress [0..*] (IdentifiedPersonAddress) |
Design Comments: This query parameter is a postal address for corresponding with a person in the context of the target person registry. |
||||||||
| identifiedPersonStatusCode [0..*] (IdentifiedPersonStatusCode) |
Design Comments: This query parameter is the status of a record in the target person registry. It is used to find records in a particular state such as "active" or "completed". |
||||||||
| identifiedPersonTelecom [0..*] (IdentifiedPersonTelecom) |
Design Comments: This query parameter is a telecommunications address for communicating with a person in the context of the target person registry. It could be a telephone number, fax number or even an email address. |
||||||||
| mothersMaidenName [0..*] (MothersMaidenName) |
Design Comments: This query parameter is the maiden name of the focal person's mother. It is included as a parameter because it is a common attribute for confirming the identity of persons in some person registries. This parameter does not map to a single RIM attribute, instead, in RIM terms Mother's maiden name is the person name part of "family" with an EntityNamePartQualifier of "birth" for the person who is the player in a PersonalRelationship of type of "mother" to the focal person. |
||||||||
| otherIDsScopingOrganization [0..*] (OtherIDsScopingOrganization) |
Design Comments: This query parameter is another organization that has registered the focal person in its registry. It is used to find persons who have been registered by a particular organization. |
||||||||
| personAdministrativeGender [0..*] (PersonAdministrativeGender) |
Design Comments: This query parameter is a code representing the administrative gender of a person. |
||||||||
| personBirthPlaceAddress [0..*] (PersonBirthPlaceAddress) |
Design Comments: This query parameter is a person's birthplace represented as an address |
||||||||
| personBirthPlaceName [0..*] (PersonBirthPlaceName) |
Design Comments: This query parameter is a person's birthplace represented as a place name |
||||||||
| personBirthTime [0..*] (PersonBirthTime) |
Design Comments: This query parameter is the birth date of a person. |
||||||||
| personDeceased [0..*] (PersonDeceased) |
Design Comments: The PersonDeceased parameter can limit the search to persons that are alive, or to deceased persons |
||||||||
| personDeceasedTime [0..*] (PersonDeceasedTime) |
Design Comments: This query parameter is the death date of a person. It is used to find persons who have died on a known date. |
||||||||
| personId [0..*] (PersonId) |
Design Comments: This query parameter is an identifier for a Person. This is NOT the identifier assigned by the target registry. In fact, the identifier has no context (scoping organization) other than the namespace from which the identifier was issued (OID root). |
||||||||
| personName [0..*] (PersonName) |
Design Comments: This query parameter is the name of a person. |
||||||||
| personRoleId [0..*] (PersonRoleId) |
Design Comments: This query parameter is an abstract concept representing the identifier for a person in any role. This could be a Patient identifier, a Citizen identifier, an OtherIds identifier. |
||||||||
| GroupId |
Design Comments: This query parameter is the identifier for a group of which a person may be a member. It used to find persons who are members of a particular identified group. |
||||||||
| value [1..*] ParameterItem (DSET<II>) |
Design Comments: The identifer for a group. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Member.Group.id"} |
|||||||||
| IdentifiedPersonAddress |
Design Comments: This query parameter is a postal address for corresponding with a person in the context of the target person registry. |
||||||||
| value [1..*] ParameterItem (DSET<AD>) |
Design Comments: A correspondence address. The use code attribute can specify whether this is a temporary address, home address, work place address, etc. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "IdentifiedPerson.addr"} |
|||||||||
| IdentifiedPersonStatusCode |
Design Comments: This query parameter is the status of a record in the target person registry. It is used to find records in a particular state such as "active" or "completed". |
||||||||
| value [1..1] ParameterItem (CV) {CNE:D:RoleStatus} |
Design Comments: A code specifying the state of a record in a person registry. This is based on the Role class state model in the RIM. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "IdentifiedPerson.statusCode"} |
|||||||||
| IdentifiedPersonTelecom |
Design Comments: This query parameter is a telecommunications address for communicating with a person in the context of the target person registry. It could be a telephone number, fax number or even an email address. |
||||||||
| value [1..*] ParameterItem (DSET<TEL>) |
Design Comments: A telecommunications address. The scheme attribute specifies whether this is a telephone number, fax number, email address, etc. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "IdentifiedPerson.telecom"} |
|||||||||
| MothersMaidenName |
Design Comments: This query parameter is the maiden name of the focal person's mother. It is included as a parameter because it is a common attribute for confirming the identity of persons in some person registries. This parameter does not map to a single RIM attribute, instead, in RIM terms Mother's maiden name is the person name part of "family" with an EntityNamePartQualifier of "birth" for the person who is the player in a PersonalRelationship of type of "mother" to the focal person. |
||||||||
| value [1..*] ParameterItem (DSET<PN>) |
Design Comments: A person name. In this case it may consist of only the family name part. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "MothersMaidenName"} |
|||||||||
| OtherIDsScopingOrganization |
Design Comments: This query parameter is another organization that has registered the focal person in its registry. It is used to find persons who have been registered by a particular organization. |
||||||||
| value [1..*] ParameterItem (DSET<II>) |
Design Comments: The identifier for another organization that has registered the focal person in its registry. For example, Hospital B registered the focal person as a patient in its patient registry. Note, this is the identity of the registering organization, not the identifier assigned to the focal person in the other registry. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "OtherIDs.scopingOrganization.id"} |
|||||||||
| PersonAdministrativeGender |
Design Comments: This query parameter is a code representing the administrative gender of a person. |
||||||||
| value [1..*] ParameterItem (DSET<CV>) {CWE:D:AdministrativeGender} |
Design Comments: A value representing the administrative gender of a person. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.administrativeGender"} |
|||||||||
| PersonBirthPlaceAddress |
Design Comments: This query parameter is a person's birthplace represented as an address |
||||||||
| value [1..*] ParameterItem (DSET<AD>) |
Design Comments: A correspondence address for the location where a person was born. This is can be a full address or only known address components such as city or country. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.BirthPlace.Addr"} |
|||||||||
| PersonBirthPlaceName |
Design Comments: This query parameter is a person's birthplace represented as a place name |
||||||||
| value [1..*] ParameterItem (DSET<EN>) |
Design Comments: A person's birthplace represented as the name of a Place playing the role of BirthPlace. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.BirthPlace.Place.Name"} |
|||||||||
| PersonBirthTime |
Design Comments: This query parameter is the birth date of a person. |
||||||||
| value [1..*] ParameterItem (DSET<IVL<TS>>) |
Design Comments: A date or date range. This parameter can convey an exact moment (e.g., January 1, 1960 @ 03:00:00 EST), an approximate date (e.g., January 1960), or even a range of dates (e.g., December 1, 1959 through March 31, 1960). Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.birthTime"} |
|||||||||
| PersonDeceased |
Design Comments: The PersonDeceased parameter can limit the search to persons that are alive, or to deceased persons |
||||||||
| value [1..1] ParameterItem (BL) |
Design Comments: This is a value of either 'true' or 'false'. True means to limit search to records for persons are are deceased. False means to limit search to records for persons who are alive. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.Deceased"} |
|||||||||
| PersonDeceasedTime |
Design Comments: This query parameter is the death date of a person. It is used to find persons who have died on a known date. |
||||||||
| value [1..*] ParameterItem (DSET<IVL<TS>>) |
Design Comments: A date or date range. The parameter can convey an exact moment (e.g., January 1, 1960 @ 03:00:00 EST), an approximate date (e.g., January 1960), or even a range of dates (e.g., December 1, 1959 through March 31, 1960). Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.deceasedTime"} |
|||||||||
| PersonId |
Design Comments: This query parameter is an identifier for a Person. This is NOT the identifier assigned by the target registry. In fact, the identifier has no context (scoping organization) other than the namespace from which the identifier was issued (OID root). |
||||||||
| value [1..*] ParameterItem (DSET<II>) |
Design Comments: An instance identifier consisting of an OID root and extension. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.id"} |
|||||||||
| PersonName |
Design Comments: This query parameter is the name of a person. |
||||||||
| value [1..*] ParameterItem (DSET<PN>) |
Design Comments: A person name. The name use attribute can convey that a name is spelled phonetically or based on the SOUNDEX algorithm. If only a family name part is sent then the query would match all persons with that family name regardless of their given names. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.name"} |
|||||||||
| PersonRoleId |
Design Comments: This query parameter is an abstract concept representing the identifier for a person in any role. This could be a Patient identifier, a Citizen identifier, an OtherIds identifier. |
||||||||
| value [1..*] ParameterItem (DSET<II>) |
Design Comments: An instance identifier consisting of an OID root and extension. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [1..1] ParameterItem (ST){default= "Person.Role.Id"} |
|||||||||
| SortControl |
Design Comments: This class allows the query requester to specify the order in which the server should return multiple results. |
||||||||
| sequenceNumber [0..1] SortControl (INT.NONNEG) |
Design Comments: Specifies the order of this elementName in the sort |
||||||||
| elementName [0..1] SortControl (SC.NT) {CWE:D:ElementName} |
Design Comments: Identifies the element upon which the response should be sorted |
||||||||
| directionCode [0..1] SortControl (CS) {CNE:V:Sequencing} |
Design Comments: Specifies sort order (ascending, descending or none) |
||||||||